caxlsx 4.0.0 → 4.2.0

data/lib/axlsx/stylesheet/color.rb

@@ -17,7 +17,7 @@ module Axlsx
 
     serializable_attributes :auto, :rgb, :tint
 
-    # Determines if the color is system color dependant
+    # Determines if the color is system color dependent
     # @return [Boolean]
     attr_reader :auto
 
@@ -47,7 +47,10 @@ module Axlsx
     attr_reader :tint
 
     # @see auto
-    def auto=(v) Axlsx.validate_boolean v; @auto = v end
+    def auto=(v)
+      Axlsx.validate_boolean v
+      @auto = v
+    end
 
     # @see color
     def rgb=(v)
@@ -61,12 +64,15 @@ module Axlsx
     end
 
     # @see tint
-    def tint=(v) Axlsx.validate_float v; @tint = v end
+    def tint=(v)
+      Axlsx.validate_float v
+      @tint = v
+    end
 
     # This version does not support themes
     # def theme=(v) Axlsx::validate_unsigned_integer v; @theme = v end
 
-    # Indexed colors are for backward compatability which I am choosing not to support
+    # Indexed colors are for backward compatibility which I am choosing not to support
     # def indexed=(v) Axlsx::validate_unsigned_integer v; @indexed = v end
 
     # Serializes the object

data/lib/axlsx/stylesheet/dxf.rb

@@ -49,17 +49,40 @@ module Axlsx
     end
 
     # @see Dxf#alignment
-    def alignment=(v) DataTypeValidator.validate "Dxf.alignment", CellAlignment, v; @alignment = v end
+    def alignment=(v)
+      DataTypeValidator.validate "Dxf.alignment", CellAlignment, v
+      @alignment = v
+    end
+
     # @see protection
-    def protection=(v) DataTypeValidator.validate "Dxf.protection", CellProtection, v; @protection = v end
+    def protection=(v)
+      DataTypeValidator.validate "Dxf.protection", CellProtection, v
+      @protection = v
+    end
+
     # @see numFmt
-    def numFmt=(v) DataTypeValidator.validate "Dxf.numFmt", NumFmt, v; @numFmt = v end
+    def numFmt=(v)
+      DataTypeValidator.validate "Dxf.numFmt", NumFmt, v
+      @numFmt = v
+    end
+
     # @see font
-    def font=(v) DataTypeValidator.validate "Dxf.font", Font, v; @font = v end
+    def font=(v)
+      DataTypeValidator.validate "Dxf.font", Font, v
+      @font = v
+    end
+
     # @see border
-    def border=(v) DataTypeValidator.validate "Dxf.border", Border, v; @border = v end
+    def border=(v)
+      DataTypeValidator.validate "Dxf.border", Border, v
+      @border = v
+    end
+
     # @see fill
-    def fill=(v) DataTypeValidator.validate "Dxf.fill", Fill, v; @fill = v end
+    def fill=(v)
+      DataTypeValidator.validate "Dxf.fill", Fill, v
+      @fill = v
+    end
 
     # Serializes the object
     # @param [String] str

data/lib/axlsx/stylesheet/fill.rb

@@ -28,6 +28,9 @@ module Axlsx
     end
 
     # @see fill_type
-    def fill_type=(v) DataTypeValidator.validate "Fill.fill_type", [PatternFill, GradientFill], v; @fill_type = v; end
+    def fill_type=(v)
+      DataTypeValidator.validate "Fill.fill_type", [PatternFill, GradientFill], v
+      @fill_type = v
+    end
   end
 end

data/lib/axlsx/stylesheet/font.rb

@@ -33,7 +33,7 @@ module Axlsx
     # The charset of the font
     # @return [Integer]
     # @note
-    #  The following values are defined in the OOXML specification and are OS dependant values
+    #  The following values are defined in the OOXML specification and are OS dependent values
     #   0   ANSI_CHARSET
     #   1   DEFAULT_CHARSET
     #   2   SYMBOL_CHARSET
@@ -112,15 +112,34 @@ module Axlsx
     attr_reader :sz
 
     # @see name
-    def name=(v) Axlsx.validate_string v; @name = v end
+    def name=(v)
+      Axlsx.validate_string v
+      @name = v
+    end
+
     # @see charset
-    def charset=(v) Axlsx.validate_unsigned_int v; @charset = v end
+    def charset=(v)
+      Axlsx.validate_unsigned_int v
+      @charset = v
+    end
+
     # @see family
-    def family=(v) Axlsx.validate_unsigned_int v; @family = v end
+    def family=(v)
+      Axlsx.validate_unsigned_int v
+      @family = v
+    end
+
     # @see b
-    def b=(v) Axlsx.validate_boolean v; @b = v end
+    def b=(v)
+      Axlsx.validate_boolean v
+      @b = v
+    end
+
     # @see i
-    def i=(v) Axlsx.validate_boolean v; @i = v end
+    def i=(v)
+      Axlsx.validate_boolean v
+      @i = v
+    end
 
     # @see u
     def u=(v)
@@ -131,19 +150,46 @@ module Axlsx
     end
 
     # @see strike
-    def strike=(v) Axlsx.validate_boolean v; @strike = v end
+    def strike=(v)
+      Axlsx.validate_boolean v
+      @strike = v
+    end
+
     # @see outline
-    def outline=(v) Axlsx.validate_boolean v; @outline = v end
+    def outline=(v)
+      Axlsx.validate_boolean v
+      @outline = v
+    end
+
     # @see shadow
-    def shadow=(v) Axlsx.validate_boolean v; @shadow = v end
+    def shadow=(v)
+      Axlsx.validate_boolean v
+      @shadow = v
+    end
+
     # @see condense
-    def condense=(v) Axlsx.validate_boolean v; @condense = v end
+    def condense=(v)
+      Axlsx.validate_boolean v
+      @condense = v
+    end
+
     # @see extend
-    def extend=(v) Axlsx.validate_boolean v; @extend = v end
+    def extend=(v)
+      Axlsx.validate_boolean v
+      @extend = v
+    end
+
     # @see color
-    def color=(v) DataTypeValidator.validate "Font.color", Color, v; @color = v end
+    def color=(v)
+      DataTypeValidator.validate "Font.color", Color, v
+      @color = v
+    end
+
     # @see sz
-    def sz=(v) Axlsx.validate_unsigned_int v; @sz = v end
+    def sz=(v)
+      Axlsx.validate_unsigned_int v
+      @sz = v
+    end
 
     # Serializes the object
     # @param [String] str

data/lib/axlsx/stylesheet/gradient_fill.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Axlsx
-  # A GradientFill defines the color and positioning for gradiant cell fill.
+  # A GradientFill defines the color and positioning for gradient cell fill.
   # @see Open Office XML Part 1 §18.8.24
   class GradientFill
     include Axlsx::OptionsParser
@@ -55,10 +55,16 @@ module Axlsx
     attr_reader :stop
 
     # @see type
-    def type=(v) Axlsx.validate_gradient_type v; @type = v end
+    def type=(v)
+      Axlsx.validate_gradient_type v
+      @type = v
+    end
 
     # @see degree
-    def degree=(v) Axlsx.validate_float v; @degree = v end
+    def degree=(v)
+      Axlsx.validate_float v
+      @degree = v
+    end
 
     # @see left
     def left=(v)

data/lib/axlsx/stylesheet/gradient_stop.rb

@@ -22,9 +22,16 @@ module Axlsx
     end
 
     # @see color
-    def color=(v) DataTypeValidator.validate "GradientStop.color", Color, v; @color = v end
+    def color=(v)
+      DataTypeValidator.validate "GradientStop.color", Color, v
+      @color = v
+    end
+
     # @see position
-    def position=(v) DataTypeValidator.validate "GradientStop.position", Float, v, ->(arg) { arg >= 0 && arg <= 1 }; @position = v end
+    def position=(v)
+      DataTypeValidator.validate "GradientStop.position", Float, v, ->(arg) { arg >= 0 && arg <= 1 }
+      @position = v
+    end
 
     # Serializes the object
     # @param [String] str

data/lib/axlsx/stylesheet/num_fmt.rb

@@ -61,10 +61,16 @@ module Axlsx
     attr_reader :numFmtId
 
     # @see numFmtId
-    def numFmtId=(v) Axlsx.validate_unsigned_int v; @numFmtId = v end
+    def numFmtId=(v)
+      Axlsx.validate_unsigned_int v
+      @numFmtId = v
+    end
 
     # @see formatCode
-    def formatCode=(v) Axlsx.validate_string v; @formatCode = v end
+    def formatCode=(v)
+      Axlsx.validate_string v
+      @formatCode = v
+    end
 
     # Serializes the object
     # @param [String] str

data/lib/axlsx/stylesheet/pattern_fill.rb

@@ -49,11 +49,22 @@ module Axlsx
     attr_reader :patternType
 
     # @see fgColor
-    def fgColor=(v) DataTypeValidator.validate "PatternFill.fgColor", Color, v; @fgColor = v end
+    def fgColor=(v)
+      DataTypeValidator.validate "PatternFill.fgColor", Color, v
+      @fgColor = v
+    end
+
     # @see bgColor
-    def bgColor=(v) DataTypeValidator.validate "PatternFill.bgColor", Color, v; @bgColor = v end
+    def bgColor=(v)
+      DataTypeValidator.validate "PatternFill.bgColor", Color, v
+      @bgColor = v
+    end
+
     # @see patternType
-    def patternType=(v) Axlsx.validate_pattern_type v; @patternType = v end
+    def patternType=(v)
+      Axlsx.validate_pattern_type v
+      @patternType = v
+    end
 
     # Serializes the object
     # @param [String] str

data/lib/axlsx/stylesheet/styles.rb

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 
 module Axlsx
-  require 'axlsx/stylesheet/border'
-  require 'axlsx/stylesheet/border_pr'
-  require 'axlsx/stylesheet/cell_alignment'
-  require 'axlsx/stylesheet/cell_style'
-  require 'axlsx/stylesheet/color'
-  require 'axlsx/stylesheet/fill'
-  require 'axlsx/stylesheet/font'
-  require 'axlsx/stylesheet/gradient_fill'
-  require 'axlsx/stylesheet/gradient_stop'
-  require 'axlsx/stylesheet/num_fmt'
-  require 'axlsx/stylesheet/pattern_fill'
-  require 'axlsx/stylesheet/table_style'
-  require 'axlsx/stylesheet/table_styles'
-  require 'axlsx/stylesheet/table_style_element'
-  require 'axlsx/stylesheet/dxf'
-  require 'axlsx/stylesheet/xf'
-  require 'axlsx/stylesheet/cell_protection'
+  require_relative 'border'
+  require_relative 'border_pr'
+  require_relative 'cell_alignment'
+  require_relative 'cell_style'
+  require_relative 'color'
+  require_relative 'fill'
+  require_relative 'font'
+  require_relative 'gradient_fill'
+  require_relative 'gradient_stop'
+  require_relative 'num_fmt'
+  require_relative 'pattern_fill'
+  require_relative 'table_style'
+  require_relative 'table_styles'
+  require_relative 'table_style_element'
+  require_relative 'dxf'
+  require_relative 'xf'
+  require_relative 'cell_protection'
 
   # The Styles class manages worksheet styles
   # In addition to creating the require style objects for a valid xlsx package, this class provides the key mechanism for adding styles to your workbook, and safely applying them to the cells of your worksheet.
-  # All portions of the stylesheet are implemented here exception colors, which specify legacy and modified pallete colors, and exLst, whic is used as a future feature data storage area.
+  # All portions of the stylesheet are implemented here exception colors, which specify legacy and modified palette colors, and exLst, which is used as a future feature data storage area.
   # @see  Office Open XML Part 1 18.8.11 for gory details on how this stuff gets put together
   # @see  Styles#add_style
   # @note The recommended way to manage styles is with add_style
@@ -156,7 +156,7 @@ module Axlsx
     #   ws = p.workbook.add_worksheet
     #
     #   # black text on a white background at 14pt with thin borders!
-    #   title = ws.styles.add_style(:bg_color => "FFFF0000", :fg_color=>"#FF000000", :sz=>14,  :border=> {:style => :thin, :color => "FFFF0000"}
+    #   title = ws.styles.add_style(:bg_color => "FFFF0000", :fg_color=>"FF000000", :sz=>14,  :border=> {:style => :thin, :color => "FFFF0000"}
     #
     #   ws.add_row ["Least Popular Pets"]
     #   ws.add_row ["", "Dry Skinned Reptiles", "Bald Cats", "Violent Parrots"], :style=>title
@@ -174,7 +174,7 @@ module Axlsx
     #
     #   # define your styles
     #   title = ws.styles.add_style(:bg_color => "FFFF0000",
-    #                              :fg_color=>"#FF000000",
+    #                              :fg_color=>"FF000000",
     #                              :border=>Axlsx::STYLE_THIN_BORDER,
     #                              :alignment=>{:horizontal => :center})
     #
@@ -209,10 +209,10 @@ module Axlsx
     #
     #   # define your styles
     #   profitable = wb.styles.add_style(:bg_color => "FFFF0000",
-    #                              :fg_color=>"#FF000000",
+    #                              :fg_color=>"FF000000",
     #                              :type => :dxf)
     #
-    #   ws.add_row ["Genreated At:", Time.now], :styles=>[nil, date_time]
+    #   ws.add_row ["Generated At:", Time.now], :styles=>[nil, date_time]
     #   ws.add_row ["Previous Year Quarterly Profits (JPY)"], :style=>title
     #   ws.add_row ["Quarter", "Profit", "% of Total"], :style=>title
     #   ws.add_row ["Q1", 4000, 40], :style=>[title, currency, percent]
@@ -245,7 +245,7 @@ module Axlsx
 
         font_defaults = { name: @fonts.first.name, sz: @fonts.first.sz, family: @fonts.first.family }
 
-        raw_style = { type: :xf }.merge(font_defaults).merge(options)
+        raw_style = { type: :xf }.merge(font_defaults, options)
 
         if raw_style[:format_code]
           raw_style.delete(:num_fmt)
@@ -275,7 +275,7 @@ module Axlsx
       if options[:type] == :xf
         xf_index = (cellXfs << style)
 
-        # Add styles to style_index cache for re-use
+        # Add styles to style_index cache for reuse
         style_index[xf_index] = raw_style
 
         xf_index
@@ -298,7 +298,7 @@ module Axlsx
 
     # parses add_style options for alignment
     # noop if options hash does not include :alignment key
-    # @option options [Hash] alignment A hash of options to prive the CellAlignment intializer
+    # @option options [Hash] alignment A hash of options to prive the CellAlignment initializer
     # @return [CellAlignment]
     # @see CellAlignment
     def parse_alignment_options(options = {})
@@ -325,27 +325,60 @@ module Axlsx
     def parse_font_options(options = {})
       return if (options.keys & [:fg_color, :sz, :b, :i, :u, :strike, :outline, :shadow, :charset, :family, :font_name]).empty?
 
-      Axlsx.instance_values_for(fonts.first).each do |key, value|
-        # Thanks for that 1.8.7 - cant do a simple merge...
-        options[key.to_sym] = value unless options.key?(key.to_sym)
-      end
-      font = Font.new(options)
+      font = Font.new(Axlsx.instance_values_for(fonts.first).merge(options))
       font.color = Color.new(rgb: options[:fg_color]) if options[:fg_color]
       font.name = options[:font_name] if options[:font_name]
       options[:type] == :dxf ? font : fonts << font
     end
 
     # parses add_style options for fills. If the options hash contains :type => :dxf we return a Fill object. If not, we return the index of the fill after being added to the fills collection.
-    # @note noop if :bg_color is not specified in options
-    # @option options [String] bg_color The rgb color to apply to the fill
+    # @note noop unless at least one of the documented attributes is specified in options
+    # @option options [String] bg_color The rgb color to apply to the fill. An alias for pattern_bg_color if you need only a solid background
+    # @option options [String] pattern_type The fill pattern to apply to the fill
+    # @option options [String] pattern_bg_color The rgb color to apply to the fill as the first color
+    # @option options [String] pattern_fg_color The rgb color to apply to the fill as the second color
     # @return [Fill|Integer]
     def parse_fill_options(options = {})
-      return unless options[:bg_color]
+      return unless options[:bg_color] || options[:pattern_type] || options[:pattern_bg_color] || options[:pattern_fg_color]
 
-      color = Color.new(rgb: options[:bg_color])
+      pattern_type = options[:pattern_type] || :solid
       dxf = options[:type] == :dxf
-      color_key = dxf ? :bgColor : :fgColor
-      pattern = PatternFill.new(:patternType => :solid, color_key => color)
+
+      pattern_options = {
+        patternType: pattern_type
+      }
+
+      if options[:pattern_bg_color] && options[:bg_color]
+        warn 'Both `bg_color` and `pattern_bg_color` got defined. To get a solid background without defining it in `patter_type`, use only `bg_color`, otherwise use only `pattern_bg_color` to avoid confusion.'
+      end
+
+      bg_color = options[:pattern_bg_color] || options[:bg_color]
+      fg_color = options[:pattern_fg_color]
+
+      # Both bgColor and fgColor happens to configure the background of the cell.
+      # One of them sets the "background" of the cell, while the other one is
+      # responsible for the "pattern" of the cell. When you pick "solid" pattern for
+      # a normal xf style, then it's a rectangle covering all bgColor with fgColor,
+      # which means we need to to set the given background color to fgColor as well.
+      # For some reason I wasn't able find, it works the opposite for dxf styles
+      # (differential formatting records), so to get the expected color, we need
+      # to put it into bgColor. We only need these cross-assignments when using
+      # "solid" pattern and the user provided only one color to get the least
+      # amount of surprise
+
+      if bg_color
+        pattern_options[:bgColor] = Color.new(rgb: bg_color)
+      elsif pattern_type == :solid && fg_color
+        pattern_options[:bgColor] = Color.new(rgb: fg_color)
+      end
+
+      if fg_color
+        pattern_options[:fgColor] = Color.new(rgb: fg_color)
+      elsif pattern_type == :solid && bg_color
+        pattern_options[:fgColor] = Color.new(rgb: bg_color)
+      end
+
+      pattern = PatternFill.new(pattern_options)
       fill = Fill.new(pattern)
       dxf ? fill : fills << fill
     end
@@ -364,7 +397,7 @@ module Axlsx
     #   { :border => { :style => :thick, :color => "FFFF0000", :edges => [:top, :bottom] }
     # @return [Border|Integer]
     def parse_border_options(options = {})
-      if options[:border].nil? && Border::EDGES.all? { |x| options["border_#{x}".to_sym].nil? }
+      if options[:border].nil? && Border::EDGES.all? { |x| options[:"border_#{x}"].nil? }
         return nil
       end
 
@@ -409,7 +442,7 @@ module Axlsx
       end
 
       Border::EDGES.each do |edge|
-        val = options["border_#{edge}".to_sym]
+        val = options[:"border_#{edge}"]
 
         if val
           borders_array << val.merge(edges: [edge])
@@ -430,8 +463,8 @@ module Axlsx
           end
         end
 
-        if options["border_#{edge}".to_sym]
-          edge_b_opts = edge_b_opts.merge(options["border_#{edge}".to_sym])
+        if options[:"border_#{edge}"]
+          edge_b_opts = edge_b_opts.merge(options[:"border_#{edge}"])
           skip_edge = false
         end
 
@@ -472,7 +505,12 @@ module Axlsx
         # If this is a standard xf we pull from numFmts the highest current and increment for num_fmt
         options[:num_fmt] ||= (@numFmts.map(&:numFmtId).max + 1) if options[:type] != :dxf
         numFmt = NumFmt.new(numFmtId: options[:num_fmt] || 0, formatCode: options[:format_code].to_s)
-        options[:type] == :dxf ? numFmt : (numFmts << numFmt; numFmt.numFmtId)
+        if options[:type] == :dxf
+          numFmt
+        else
+          numFmts << numFmt
+          numFmt.numFmtId
+        end
       else
         options[:num_fmt]
       end
@@ -534,8 +572,10 @@ module Axlsx
       @cellXfs << Xf.new(borderId: 0, xfId: 0, numFmtId: 14, fontId: 0, fillId: 0, applyNumberFormat: 1)
       @cellXfs.lock
 
-      @dxfs = SimpleTypedList.new(Dxf, "dxfs"); @dxfs.lock
-      @tableStyles = TableStyles.new(defaultTableStyle: "TableStyleMedium9", defaultPivotStyle: "PivotStyleLight16"); @tableStyles.lock
+      @dxfs = SimpleTypedList.new(Dxf, "dxfs")
+      @dxfs.lock
+      @tableStyles = TableStyles.new(defaultTableStyle: "TableStyleMedium9", defaultPivotStyle: "PivotStyleLight16")
+      @tableStyles.lock
     end
   end
 end

data/lib/axlsx/stylesheet/table_style.rb

@@ -15,7 +15,7 @@ module Axlsx
     def initialize(name, options = {})
       self.name = name
       parse_options options
-      super TableStyleElement
+      super(TableStyleElement)
     end
 
     serializable_attributes :name, :pivot, :table
@@ -33,11 +33,22 @@ module Axlsx
     attr_reader :table
 
     # @see name
-    def name=(v) Axlsx.validate_string v; @name = v end
+    def name=(v)
+      Axlsx.validate_string v
+      @name = v
+    end
+
     # @see pivot
-    def pivot=(v) Axlsx.validate_boolean v; @pivot = v end
+    def pivot=(v)
+      Axlsx.validate_boolean v
+      @pivot = v
+    end
+
     # @see table
-    def table=(v) Axlsx.validate_boolean v; @table = v end
+    def table=(v)
+      Axlsx.validate_boolean v
+      @table = v
+    end
 
     # Serializes the object
     # @param [String] str

data/lib/axlsx/stylesheet/table_style_element.rb

@@ -58,13 +58,22 @@ module Axlsx
     attr_reader :dxfId
 
     # @see type
-    def type=(v) Axlsx.validate_table_element_type v; @type = v end
+    def type=(v)
+      Axlsx.validate_table_element_type v
+      @type = v
+    end
 
     # @see size
-    def size=(v) Axlsx.validate_unsigned_int v; @size = v end
+    def size=(v)
+      Axlsx.validate_unsigned_int v
+      @size = v
+    end
 
     # @see dxfId
-    def dxfId=(v) Axlsx.validate_unsigned_int v; @dxfId = v end
+    def dxfId=(v)
+      Axlsx.validate_unsigned_int v
+      @dxfId = v
+    end
 
     # Serializes the object
     # @param [String] str

data/lib/axlsx/stylesheet/table_styles.rb

@@ -12,7 +12,7 @@ module Axlsx
     def initialize(options = {})
       @defaultTableStyle = options[:defaultTableStyle] || "TableStyleMedium9"
       @defaultPivotStyle = options[:defaultPivotStyle] || "PivotStyleLight16"
-      super TableStyle
+      super(TableStyle)
     end
 
     serializable_attributes :defaultTableStyle, :defaultPivotStyle
@@ -26,9 +26,16 @@ module Axlsx
     attr_reader :defaultPivotStyle
 
     # @see defaultTableStyle
-    def defaultTableStyle=(v) Axlsx.validate_string(v); @defaultTableStyle = v; end
+    def defaultTableStyle=(v)
+      Axlsx.validate_string(v)
+      @defaultTableStyle = v
+    end
+
     # @see defaultPivotStyle
-    def defaultPivotStyle=(v) Axlsx.validate_string(v); @defaultPivotStyle = v; end
+    def defaultPivotStyle=(v)
+      Axlsx.validate_string(v)
+      @defaultPivotStyle = v
+    end
 
     # Serializes the object
     # @param [String] str