axlsx 1.1.4 → 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,21 +1,43 @@
 # -*- 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'
+require 'axlsx/workbook/worksheet/print_options.rb'
 require 'axlsx/workbook/worksheet/cfvo.rb'
 require 'axlsx/workbook/worksheet/color_scale.rb'
 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'
   # The Workbook class is an xlsx workbook that manages worksheets, charts, drawings and styles.
   # The following parts of the Office Open XML spreadsheet specification are not implimented in this version.
   #
@@ -82,6 +104,9 @@ require 'axlsx/workbook/worksheet/table.rb'
     # @return [SimpleTypedList]
     attr_reader :drawings
 
+    # pretty sure this two are always empty and can be removed.
+
+
     # A colllection of tables associated with this workbook
     # @note The recommended way to manage drawings is Worksheet#add_table
     # @see Worksheet#add_table
@@ -90,6 +115,23 @@ require 'axlsx/workbook/worksheet/table.rb'
     attr_reader :tables
 
 
+    # 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
+      worksheets.map { |sheet| sheet.comments }.compact
+    end
+
     # The styles associated with this workbook
     # @note The recommended way to manage styles is Styles#add_style
     # @see Style#add_style
@@ -123,7 +165,11 @@ require 'axlsx/workbook/worksheet/table.rb'
       @drawings = SimpleTypedList.new Drawing
       @charts = SimpleTypedList.new Chart
       @images = SimpleTypedList.new Pic
+      # Are these even used????? Check package serialization parts
       @tables = SimpleTypedList.new Table
+      @comments = SimpleTypedList.new Comments
+
+
       @use_autowidth = true
 
       self.date1904= !options[:date1904].nil? && options[:date1904]
@@ -146,12 +192,14 @@ require 'axlsx/workbook/worksheet/table.rb'
     def self.date1904() @@date1904; end
 
     # Indicates if the workbook should use autowidths or not.
-    # this must be set before instantiating a worksheet to avoid Rmagix inclusion
+    # @note This gem no longer depends on RMagick for autowidth
+    #     calculation. Thus the performance benefits of turning this off are
+    #     marginal unless you are creating a very large sheet.
     # @return [Boolean]
     def use_autowidth() @use_autowidth; end
 
     # see @use_autowidth
-    def use_autowidth=(v) Axlsx::validate_boolean v; @use_autowidth = v; end
+    def use_autowidth=(v=true) Axlsx::validate_boolean v; @use_autowidth = v; end
 
     # Adds a worksheet to this workbook
     # @return [Worksheet]
@@ -164,6 +212,14 @@ require 'axlsx/workbook/worksheet/table.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
@@ -205,17 +261,13 @@ require 'axlsx/workbook/worksheet/table.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

@@ -142,7 +142,7 @@ module Axlsx
     # The inline color property for the cell
     # @return [Color]
     attr_reader :color
-    # @param [String] The 8 character representation for an rgb color #FFFFFFFF"
+    # @param [String] v The 8 character representation for an rgb color #FFFFFFFF"
     def color=(v)
       @color = v.is_a?(Color) ? v : Color.new(:rgb=>v)
       @is_text_run = true
@@ -195,7 +195,7 @@ module Axlsx
     # @option options [Symbol] scheme must be one of :none, major, :minor
     def initialize(row, value="", options={})
       self.row=row
-      @font_name = @charset = @family = @b = @i = @strike = @outline = @shadow = nil
+      @value = @font_name = @charset = @family = @b = @i = @strike = @outline = @shadow = nil
       @condense = @u = @vertAlign = @sz = @color = @scheme = @extend = @ssti = nil
       @styles = row.worksheet.workbook.styles
       @row.cells << self
@@ -261,9 +261,8 @@ module Axlsx
     # @return [String]
     def run_xml_string(str = '')
       if is_text_run?
-        data = self.instance_values.reject{|key, value| value == nil }
+        data = instance_values.reject{|key, value| value == nil || key == 'value' || key == 'type' }
         keys = data.keys & INLINE_STYLES
-        keys.delete ['value', 'type']
         str << "<r><rPr>"
         keys.each do |key|
           case key
@@ -272,7 +271,7 @@ module Axlsx
           when 'color'
             str << data[key].to_xml_string
           else
-            "<" << key.to_s << " val='" << data[key].to_s << "'/>"
+            str << "<" << key.to_s << " val='" << data[key].to_s << "'/>"
           end
         end
         str << "</rPr>" << "<t>" << value.to_s << "</t></r>"
@@ -288,13 +287,15 @@ module Axlsx
     # @param [String] str The string index the cell content will be appended to. Defaults to empty string.
     # @return [String] xml text for the cell
     def to_xml_string(r_index, c_index, str = '')
-      return str if @value.nil?
       str << '<c r="' << Axlsx::cell_r(c_index, r_index) << '" s="' << @style.to_s << '" '
+      return str << '/>' if @value.nil?
+
       case @type
+
       when :string
         #parse formula
         if @value.start_with?('=')
-          str  << 't="str"><f>' << @value.to_s.gsub('=', '') << '</f>'
+          str  << 't="str"><f>' << @value.to_s.sub('=', '') << '</f>'
         else
           #parse shared
           if @ssti
@@ -316,8 +317,35 @@ module Axlsx
       str << '</c>'
     end
 
+    def is_formula?
+      @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/comment.rb

@@ -0,0 +1,101 @@
+module Axlsx
+
+  # A comment is the text data for a comment
+  class Comment
+
+    # The text to render
+    # @return [String]
+    attr_reader :text
+
+    # The author of this comment
+    # @see Comments
+    # @return [String]
+    attr_reader :author
+
+    # The owning Comments object
+    # @return [Comments]
+    attr_reader :comments
+
+
+    # The string based cell position reference (e.g. 'A1') that determines the positioning of this comment
+    # @return [String]
+    attr_reader :ref
+
+    # TODO
+    # r (Rich Text Run)
+    # rPh (Phonetic Text Run)
+    # phoneticPr (Phonetic Properties)
+
+    def initialize(comments, options={})
+      raise ArgumentError, "A comment needs a parent comments object" unless comments.is_a?(Comments)
+      @comments = comments
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+      yield self if block_given?
+    end
+
+    # The vml shape that will render this comment
+    # @return [VmlShape]
+    def vml_shape
+      @vml_shape ||= initialize_vml_shape
+    end
+
+    #
+    # The index of this author in a unique sorted list of all authors in
+    # the comment.
+    # @return [Integer]
+    def author_index
+      @comments.authors.index(author)
+    end
+
+    # @see ref
+    def ref=(v)
+      Axlsx::DataTypeValidator.validate "Comment.ref", [String, Cell], v
+      @ref = v if v.is_a?(String)
+      @ref = v.r if v.is_a?(Cell)
+    end
+
+    # @see text
+    def text=(v)
+      Axlsx::validate_string(v)
+      @text = v
+    end
+
+    # @see author
+    def author=(v)
+      @author = v
+    end
+
+    # serialize the object
+    # @param [String] str
+    # @return [String]
+    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 << '<r>'
+      str << '<rPr><color indexed="81"/></rPr>'
+      str << '<t>' << text << '</t></r></text>'
+      str << '</comment>'
+    end
+
+    private
+
+    # initialize the vml shape based on this comment's ref/position in the worksheet.
+    # by default, all columns are 5 columns wide and 5 rows high
+    def initialize_vml_shape
+      pos = Axlsx::name_to_indices(ref)
+      @vml_shape = VmlShape.new(:row => pos[1], :column => pos[0]) do |vml|
+        vml.left_column = vml.column
+        vml.right_column = vml.column + 2 
+        vml.top_row = vml.row
+         vml.bottom_row = vml.row + 4
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*-
+module Axlsx
+
+  # Comments is a collection of Comment objects for a worksheet
+  class Comments < SimpleTypedList
+
+    # the vml_drawing that holds the shapes for comments
+    # @return [VmlDrawing]
+    attr_reader :vml_drawing
+
+    # The worksheet that these comments belong to
+    # @return [Worksheet]
+    attr_reader :worksheet
+
+    # The index of this collection in the workbook. Effectively the index of the worksheet.
+    # @return [Integer]
+    def index
+      @worksheet.index
+    end
+
+    # The part name for this object
+    # @return [String]
+    def pn
+      "#{COMMENT_PN % (index+1)}"
+    end
+
+    # Creates a new Comments object
+    # @param [Worksheet] worksheet The sheet that these comments belong to.
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+      super(Comment)
+      @worksheet = worksheet
+      @vml_drawing = VmlDrawing.new(self)
+    end
+
+    # Adds a new comment to the worksheet that owns these comments.
+    # @note the author, text and ref options are required
+    # @option options [String] author The name of the author for this comment
+    # @option options [String] text The text for this comment
+    # @option options [Stirng|Cell] ref The cell that this comment is attached to.
+    def add_comment(options={})
+      raise ArgumentError, "Comment require an author" unless options[:author]
+      raise ArgumentError, "Comment requires text" unless options[:text]
+      raise ArgumentError, "Comment requires ref" unless options[:ref]
+      @list << Comment.new(self, options)
+      yield @list.last if block_given?
+      @list.last
+    end
+
+    # A sorted list of the unique authors in the contained comments
+    # @return [Array]
+    def authors
+      @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]
+    def to_xml_string(str="")
+      str << '<?xml version="1.0" encoding="UTF-8"?>'
+      str << '<comments xmlns="' << XML_NS << '">'
+      str << '<authors>'
+      authors.each do  |author|
+        str << '<author>' << author.to_s << '</author>'
+      end
+      str << '</authors>'
+      str << '<commentList>'
+      @list.each do |comment|
+        comment.to_xml_string str
+      end
+      str << '</commentList></comments>'
+
+    end
+
+  end
+
+end

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