axlsx 1.1.4 → 1.3.1

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

@@ -0,0 +1,253 @@
+module Axlsx
+
+  # When multiple values are chosen to filter by, or when a group of date values are chosen to filter by, 
+  # this object groups those criteria together.
+  class Filters
+
+    # Allowed calendar types
+    CALENDAR_TYPES = %w(gregorian gregorianUs gregorianMeFrench gregorianArabic hijri hebrew taiwan japan thai korea saka gregorianXlitEnglish gregorianXlitFrench none)
+
+    # Creates a new Filters object
+    # @param [Hash] options Options used to set this objects attributes and
+    #                       create filter and/or date group items
+    # @option [Boolean] blank @see blank
+    # @option [String] calendar_type @see calendar_type
+    # @option [Array] filter_items An array of values that will be used to create filter objects.
+    # @option [Array] date_group_items An array of hases defining date group item filters to apply.
+    # @note The recommended way to interact with filter objects is via AutoFilter#add_column
+    # @example
+    #   ws.auto_filter.add_column(0, :filters, :blank => true, :calendar_type => 'japan', :filter_items => [100, 'a'])
+    def initialize(options={})
+      options.each do |key, value|
+        self.send("#{key}=", value) if self.respond_to? "#{key}="
+      end
+    end
+
+    # Flag indicating whether to filter by blank.
+    # @return [Boolean]
+    attr_reader :blank
+
+    # Calendar type for date grouped items. 
+    # Used to interpret the values in dateGroupItem.
+    # This is the calendar type used to evaluate all dates in the filter column,
+    # even when those dates are not using the same calendar system / date formatting.
+    attr_reader :calendar_type
+
+    # Tells us if the row of the cell provided should be filterd as it
+    # does not meet any of the specified filter_items or
+    # date_group_items restrictions.
+    # @param [Cell] cell The cell to test against items
+    # TODO implement this for date filters as well!
+    def apply(cell)
+      return false unless cell
+      filter_items.each do |filter|
+        return false if cell.value == filter.val
+      end
+      true
+    end
+      
+    # The filter values in this filters object
+    def filter_items
+      @filter_items ||= []
+    end
+
+    # the date group values in this filters object
+    def date_group_items
+      @date_group_items ||= []
+    end
+
+    # @see calendar_type
+    # @param [String] calendar The calendar type to use. This must be one of the types defined in CALENDAR_TYPES
+    # @return [String]
+    def calendar_type=(calendar)
+      RestrictionValidator.validate 'Filters.calendar_type', CALENDAR_TYPES, calendar
+      @calendar_type = calendar
+    end
+
+    # Set the value for blank
+    # @see blank
+    def blank=(use_blank)
+      Axlsx.validate_boolean use_blank
+      @blank = use_blank
+    end
+
+    # Serialize the object to xml
+    def to_xml_string(str = '')
+      str << "<filters #{serialized_attributes}>"
+      filter_items.each {  |filter| filter.to_xml_string(str) }
+      date_group_items.each { |date_group_item| date_group_item.to_xml_string(str) }
+      str << '</filters>'
+    end
+
+    # not entirely happy with this. 
+    # filter_items should be a simple typed list that overrides << etc
+    # to create Filter objects from the inserted values. However this
+    # is most likely so rarely used...(really? do you know that?)
+    def filter_items=(values)
+      values.each do |value|
+        filter_items << Filter.new(value)
+      end
+    end
+
+    # Date group items are date group filter items where you specify the
+    # date_group and a value for that option as part of the auto_filter
+    # @note This can be specified, but will not be applied to the date
+    # values in your workbook at this time.
+    def date_group_items=(options)
+      options.each do |date_group|
+        raise ArgumentError, "date_group_items should be an array of hashes specifying the options for each date_group_item" unless date_group.is_a?(Hash)
+        date_group_items << DateGroupItem.new(date_group)
+      end
+    end
+
+    private
+
+    def serialized_attributes(str='')
+      instance_values.each do |key, value|
+        if %(blank claendar_type).include? key.to_s
+        str << "#{Axlsx.camel(key, false)}='#{value}' "
+        end
+      end
+      str
+    end
+
+    # This class expresses a filter criteria value.
+    class Filter
+
+      # Creates a new filter value object
+      # @param [Any] value   The value of the filter. This is not restricted, but
+      #                       will be serialized via to_s so if you are passing an object
+      #                       be careful.
+      def initialize(value)
+        @val = value
+      end
+
+
+      #Filter value used in the criteria.
+      attr_accessor :val
+
+      # Serializes the filter value object
+      # @param [String] str The string to concact the serialization information to.
+      def to_xml_string(str = '')
+        str << "<filter val='#{@val.to_s}' />"
+      end
+    end
+
+
+    # This collection is used to express a group of dates or times which are
+    # used in an AutoFilter criteria. Values are always written in the calendar
+    # type of the first date encountered in the filter range, so that all
+    # subsequent dates, even when formatted or represented by other calendar
+    # types, can be correctly compared for the purposes of filtering.
+    class DateGroupItem
+
+      # Allowed date time groupings
+      DATE_TIME_GROUPING = %w(year month day hour minute second)
+
+      # Creates a new DateGroupItem
+      # @param [Hash] options A hash of options to use when
+      # instanciating the object
+      # @option [String] date_time_grouping the part of the date this
+      # filter should apply for grouping
+      # @option [Integer|String] year @see year
+      # @option [Integer] month @see month
+      # @option [Integer] day @see day
+      # @option [Integer] hour @see hour
+      # @option [Integer] minute @see minute
+      # @option [Integer] second @see second
+      def initialize(options={})
+        raise ArgumentError,  "You must specify a year for date time grouping" unless options[:year]
+        raise ArgumentError, "You must specify a date_time_grouping when creating a DateGroupItem for auto filter" unless options[:date_time_grouping]
+        options.each do |key, value|
+          self.send("#{key}=", value) if self.respond_to?("#{key}=")
+        end
+      end
+
+      # Grouping level
+      # This must be one of year, month, day, hour, minute or second.
+      # @return [String]
+      attr_reader :date_time_grouping
+
+      # Year (4 digits)
+      # @return [Integer|String]
+      attr_reader :year
+
+      # Month (1..12)
+      # @return [Integer]
+      attr_reader :month
+
+      # Day (1-31)
+      # @return [Integer]
+      attr_reader :day
+
+      # Hour (0..23)
+      # @return [Integer]
+      attr_reader :hour
+
+      # Minute (0..59(
+      # @return [Integer]
+      attr_reader :minute
+
+      # Second (0..59)
+      # @return [Integer]
+      attr_reader :second
+
+      # The year value for the date group item
+      # This must be a four digit value
+      def year=(value)
+        RegexValidator.validate "DateGroupItem.year", /\d{4}/, value
+        @year = value
+      end
+
+      # The month value for the date group item
+      # This must be between 1 and 12
+      def month=(value)
+        RangeValidator.validate "DateGroupItem.month", 0, 12, value
+        @month = value
+      end
+
+      # The day value for the date group item
+      # This must be between 1 and 31 
+      # @note no attempt is made to ensure the date value is valid for any given month
+      def day=(value)
+        RangeValidator.validate "DateGroupItem.day", 0, 31, value
+        @day = value
+      end
+
+      # The hour value for the date group item
+      # # this must be between 0 and 23
+      def hour=(value)
+        RangeValidator.validate "DateGroupItem.hour", 0, 23, value
+        @hour = value
+      end
+
+      # The minute value for the date group item
+      # This must be between 0 and 59
+      def minute=(value)
+         RangeValidator.validate "DateGroupItem.minute", 0, 59, value
+         @minute = value
+      end
+
+      # The second value for the date group item
+      # This must be between 0 and 59
+      def second=(value)
+        RangeValidator.validate "DateGroupItem.second", 0, 59, value
+        @second = value
+      end
+
+      # The date time grouping for this filter.
+      def date_time_grouping=(grouping)
+        RestrictionValidator.validate 'DateGroupItem.date_time_grouping', DATE_TIME_GROUPING, grouping.to_s
+        @date_time_grouping = grouping.to_s
+      end
+
+      # Serialize the object to xml
+      # @param [String] str The string object this serialization will be concatenated to.
+      def to_xml_string(str = '')
+        str << '<dateGroupItem '
+        instance_values.each { |key, value| str << "#{key}='#{value.to_s}' " }
+        str << '/>'
+      end
+    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,40 @@ 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
 
+    # 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.
+    def font_size
+        font = @styles.fonts[@styles.cellXfs[style].fontId] || @styles.fonts[0]
+        size_from_styles = (font.b || b) ? font.sz * 1.5 : font.sz
+        sz || size_from_styles
+    end
+
     # Utility method for setting inline style attributes
     def set_run_style( validator, attr, value)
       return unless INLINE_STYLES.include?(attr.to_s)
@@ -352,7 +385,7 @@ module Axlsx
         :boolean
       elsif v.to_s.match(/\A[+-]?\d+?\Z/) #numeric
         :integer
-      elsif v.to_s.match(/\A[+-]?\d+\.\d+?\Z/) #float
+      elsif v.to_s.match(/\A[-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?\Z/) #float
         :float
       else
         :string

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