axlsx 1.1.8 → 1.2.0

data/lib/axlsx/workbook/defined_names.rb

@@ -0,0 +1,21 @@
+module Axlsx
+  # a simple types list of DefinedName objects
+  class DefinedNames < SimpleTypedList
+
+    # creates the DefinedNames object
+    def initialize
+      super DefinedName
+    end
+
+    # Serialize to xml
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      return if @list.empty?
+      str << "<definedNames>"
+      each { |defined_name| defined_name.to_xml_string(str) }
+      str << '</definedNames>'
+    end
+  end
+end
+

data/lib/axlsx/workbook/workbook.rb

@@ -1,8 +1,9 @@
 # -*- coding: utf-8 -*-
 module Axlsx
-
+require 'axlsx/workbook/worksheet/auto_filter.rb'
 require 'axlsx/workbook/worksheet/date_time_converter.rb'
 require 'axlsx/workbook/worksheet/protected_range.rb'
+require 'axlsx/workbook/worksheet/protected_ranges.rb'
 require 'axlsx/workbook/worksheet/cell.rb'
 require 'axlsx/workbook/worksheet/page_margins.rb'
 require 'axlsx/workbook/worksheet/page_setup.rb'
@@ -13,15 +14,27 @@ require 'axlsx/workbook/worksheet/data_bar.rb'
 require 'axlsx/workbook/worksheet/icon_set.rb'
 require 'axlsx/workbook/worksheet/conditional_formatting.rb'
 require 'axlsx/workbook/worksheet/conditional_formatting_rule.rb'
+require 'axlsx/workbook/worksheet/conditional_formattings.rb'
 require 'axlsx/workbook/worksheet/row.rb'
 require 'axlsx/workbook/worksheet/col.rb'
+require 'axlsx/workbook/worksheet/cols.rb'
 require 'axlsx/workbook/worksheet/comments.rb'
 require 'axlsx/workbook/worksheet/comment.rb'
+require 'axlsx/workbook/worksheet/merged_cells.rb'
 require 'axlsx/workbook/worksheet/sheet_protection.rb'
+require 'axlsx/workbook/worksheet/sheet_pr.rb'
+require 'axlsx/workbook/worksheet/dimension.rb'
+require 'axlsx/workbook/worksheet/sheet_data.rb'
+require 'axlsx/workbook/worksheet/worksheet_drawing.rb'
+require 'axlsx/workbook/worksheet/worksheet_comments.rb'
 require 'axlsx/workbook/worksheet/worksheet.rb'
 require 'axlsx/workbook/shared_strings_table.rb'
+require 'axlsx/workbook/defined_name.rb'
+require 'axlsx/workbook/defined_names.rb'
 require 'axlsx/workbook/worksheet/table.rb'
+require 'axlsx/workbook/worksheet/tables.rb'
 require 'axlsx/workbook/worksheet/data_validation.rb'
+require 'axlsx/workbook/worksheet/data_validations.rb'
 require 'axlsx/workbook/worksheet/sheet_view.rb'
 require 'axlsx/workbook/worksheet/pane.rb'
 require 'axlsx/workbook/worksheet/selection.rb'
@@ -101,13 +114,22 @@ require 'axlsx/workbook/worksheet/selection.rb'
     # @return [SimpleTypedList]
     attr_reader :tables
 
-    # A colllection of comments associated with this workbook
-    # @note The recommended way to manage comments is Worksheet#add_comment
+
+    # A collection of defined names for this workbook
+    # @note The recommended way to manage defined names is Workbook#add_defined_name
+    # @see DefinedName 
+    # @return [DefinedNames]
+    def defined_names
+      @defined_names ||= DefinedNames.new
+    end
+
+    # A collection of comments associated with this workbook
+    # @note The recommended way to manage comments is WOrksheet#add_comment
     # @see Worksheet#add_comment
     # @see Comment
     # @return [Comments]
     def comments
-      self.worksheets.map { |ws| ws.comments }.compact
+      worksheets.map { |sheet| sheet.comments }.compact
     end
 
     # The styles associated with this workbook
@@ -190,6 +212,14 @@ require 'axlsx/workbook/worksheet/selection.rb'
       worksheet
     end
 
+    # Adds a defined name to this workbook
+    # @return [DefinedName]
+    # @param [String] formula @see DefinedName
+    # @param [Hash] options @see DefinedName
+    def add_defined_name(formula, options)
+      defined_names << DefinedName.new(formula, options)
+    end
+
     # The workbook relationships. This is managed automatically by the workbook
     # @return [Relationships]
     def relationships
@@ -231,17 +261,13 @@ require 'axlsx/workbook/worksheet/selection.rb'
       str << '<workbookPr date1904="' << @@date1904.to_s << '"/>'
       str << '<sheets>'
       @worksheets.each_with_index do |sheet, index|
-         str << '<sheet name="' << sheet.name << '" sheetId="' << (index+1).to_s << '" r:id="' << sheet.rId << '"/>'
-      end
-      str << '</sheets>'
-      str << '<definedNames>'
-      @worksheets.each_with_index do |sheet, index|
-        if sheet.auto_filter
-          str << '<definedName name="_xlnm._FilterDatabase" localSheetId="' << index.to_s << '" hidden="1">'
-          str << sheet.abs_auto_filter << '</definedName>'
+        str << '<sheet name="' << sheet.name << '" sheetId="' << (index+1).to_s << '" r:id="' << sheet.rId << '"/>'
+        if defined_name = sheet.auto_filter.defined_name
+          add_defined_name defined_name, :name => '_xlnm._FilterDatabase', :local_sheet_id => index, :hidden => 1
         end
       end
-      str << '</definedNames>'
+      str << '</sheets>'
+      defined_names.to_xml_string(str)
       str << '</workbook>'
     end
 

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

@@ -0,0 +1,34 @@
+module Axlsx
+
+  #This class represents an auto filter range in a worksheet
+  class AutoFilter
+
+    # creates a new Autofilter object
+    # @param [Worksheet] worksheet
+    def initialize(worksheet)
+      raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
+      @worksheet = worksheet
+    end
+
+    attr_reader :worksheet
+
+    # The range the autofilter should be applied to.
+    # This should be a string like 'A1:B8'
+    # @return [String]
+    attr_accessor :range
+
+    # the formula for the defined name required for this auto filter
+    # @return [String]
+    def defined_name
+      return unless range
+      Axlsx.cell_range(range.split(':').collect { |name| worksheet.name_to_cell(name)})
+    end
+
+    # serialize the object
+    # @return [String]
+    def to_xml_string(str='')
+      str << "<autoFilter ref='#{range}'></autoFilter>"
+    end
+
+  end
+end

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

@@ -318,11 +318,34 @@ module Axlsx
     end
 
     def is_formula?
-      @type == :string && @value.start_with?('=')
+      @type == :string && @value.to_s.start_with?('=')
     end
 
+    # This is still not perfect...
+    #  - scaling is not linear as font sizes increst
+    #  - different fonts have different mdw and char widths
+    def autowidth
+      return if is_formula? || value == nil
+      mdw = 1.78 #This is the widest width of 0..9 in arial@10px)
+      font_scale = (font_size/10.0).to_f
+      ((value.to_s.count(Worksheet.thin_chars) * mdw + 5) / mdw * 256) / 256.0 * font_scale
+    end
+   
+    # returns the absolute or relative string style reference for
+    # this cell. 
+    # @param [Boolean] absolute -when false a relative reference will be
+    # returned. 
+    # @return [String]
+    def reference(absolute=true)
+      absolute ? r_abs : r
+    end 
+    
     private
 
+    def font_size
+        sz || @styles.fonts[@styles.cellXfs[style].fontId].sz
+    end
+
     # Utility method for setting inline style attributes
     def set_run_style( validator, attr, value)
       return unless INLINE_STYLES.include?(attr.to_s)

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_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/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