caxlsx 4.0.0 → 4.1.0

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

@@ -336,16 +336,53 @@ module Axlsx
     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
+      # responsibe 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 +401,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 +446,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 +467,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 +509,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 +576,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

data/lib/axlsx/stylesheet/xf.rb

@@ -95,41 +95,94 @@ module Axlsx
     attr_reader :applyProtection
 
     # @see Xf#alignment
-    def alignment=(v) DataTypeValidator.validate "Xf.alignment", CellAlignment, v; @alignment = v end
+    def alignment=(v)
+      DataTypeValidator.validate "Xf.alignment", CellAlignment, v
+      @alignment = v
+    end
 
     # @see protection
-    def protection=(v) DataTypeValidator.validate "Xf.protection", CellProtection, v; @protection = v end
+    def protection=(v)
+      DataTypeValidator.validate "Xf.protection", CellProtection, v
+      @protection = v
+    end
 
     # @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 fontId
-    def fontId=(v) Axlsx.validate_unsigned_int v; @fontId = v end
+    def fontId=(v)
+      Axlsx.validate_unsigned_int v
+      @fontId = v
+    end
+
     # @see fillId
-    def fillId=(v) Axlsx.validate_unsigned_int v; @fillId = v end
+    def fillId=(v)
+      Axlsx.validate_unsigned_int v
+      @fillId = v
+    end
+
     # @see borderId
-    def borderId=(v) Axlsx.validate_unsigned_int v; @borderId = v end
+    def borderId=(v)
+      Axlsx.validate_unsigned_int v
+      @borderId = v
+    end
+
     # @see xfId
-    def xfId=(v) Axlsx.validate_unsigned_int v; @xfId = v end
+    def xfId=(v)
+      Axlsx.validate_unsigned_int v
+      @xfId = v
+    end
+
     # @see quotePrefix
-    def quotePrefix=(v) Axlsx.validate_boolean v; @quotePrefix = v end
+    def quotePrefix=(v)
+      Axlsx.validate_boolean v
+      @quotePrefix = v
+    end
+
     # @see pivotButton
-    def pivotButton=(v) Axlsx.validate_boolean v; @pivotButton = v end
+    def pivotButton=(v)
+      Axlsx.validate_boolean v
+      @pivotButton = v
+    end
+
     # @see applyNumberFormat
-    def applyNumberFormat=(v) Axlsx.validate_boolean v; @applyNumberFormat = v end
+    def applyNumberFormat=(v)
+      Axlsx.validate_boolean v
+      @applyNumberFormat = v
+    end
+
     # @see applyFont
-    def applyFont=(v) Axlsx.validate_boolean v; @applyFont = v end
+    def applyFont=(v)
+      Axlsx.validate_boolean v
+      @applyFont = v
+    end
+
     # @see applyFill
-    def applyFill=(v) Axlsx.validate_boolean v; @applyFill = v end
+    def applyFill=(v)
+      Axlsx.validate_boolean v
+      @applyFill = v
+    end
 
     # @see applyBorder
-    def applyBorder=(v) Axlsx.validate_boolean v; @applyBorder = v end
+    def applyBorder=(v)
+      Axlsx.validate_boolean v
+      @applyBorder = v
+    end
 
     # @see applyAlignment
-    def applyAlignment=(v) Axlsx.validate_boolean v; @applyAlignment = v end
+    def applyAlignment=(v)
+      Axlsx.validate_boolean v
+      @applyAlignment = v
+    end
 
     # @see applyProtection
-    def applyProtection=(v) Axlsx.validate_boolean v; @applyProtection = v end
+    def applyProtection=(v)
+      Axlsx.validate_boolean v
+      @applyProtection = v
+    end
 
     # Serializes the object
     # @param [String] str

data/lib/axlsx/util/accessors.rb

@@ -44,19 +44,21 @@ module Axlsx
         validated_attr_accessor(symbols, :validate_boolean)
       end
 
-      # Template for defining validated write accessors
-      SETTER = "def %s=(value) Axlsx::%s(value); @%s = value; end"
-
       # Creates the reader and writer access methods
-      # @param [Array] symbols The names of the attributes to create
-      # @param [String] validator The axlsx validation method to use when
+      # @param [Array<Symbol, String>] symbols The names of the attributes to create
+      # @param [Symbol|String] validator The axlsx validation method to use when
       # validating assignation.
       # @see lib/axlsx/util/validators.rb
       def validated_attr_accessor(symbols, validator)
         symbols.each do |symbol|
           attr_reader symbol
 
-          module_eval(format(SETTER, symbol, validator, symbol), __FILE__, __LINE__)
+          module_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+            def #{symbol}=(value)      # def name=(value)
+              Axlsx.#{validator} value #   Axlsx.validate_string value
+              @#{symbol} = value       #   @name = value
+            end                        # end
+          RUBY_EVAL
         end
       end
     end

data/lib/axlsx/util/storage.rb

@@ -133,7 +133,7 @@ module Axlsx
       @left = @right = @child = -1
       @sector = @size = @created = @modified = 0
       options.each do |o|
-        send("#{o[0]}=", o[1]) if respond_to? "#{o[0]}="
+        send(:"#{o[0]}=", o[1]) if respond_to? :"#{o[0]}="
       end
       @color ||= COLORS[:black]
       @type ||= (data.nil? ? TYPES[:storage] : TYPES[:stream])

data/lib/axlsx/version.rb

@@ -2,5 +2,5 @@
 
 module Axlsx
   # The current version
-  VERSION = "4.0.0"
+  VERSION = "4.1.0"
 end

data/lib/axlsx/workbook/defined_names.rb

@@ -5,7 +5,7 @@ module Axlsx
   class DefinedNames < SimpleTypedList
     # creates the DefinedNames object
     def initialize
-      super DefinedName
+      super(DefinedName)
     end
 
     # Serialize to xml

data/lib/axlsx/workbook/workbook.rb

@@ -249,18 +249,28 @@ module Axlsx
 
     # Instance level access to the class variable 1904
     # @return [Boolean]
-    def date1904() @@date1904; end
+    def date1904
+      @@date1904
+    end
 
     # see @date1904
-    def date1904=(v) Axlsx.validate_boolean v; @@date1904 = v; end
+    def date1904=(v)
+      Axlsx.validate_boolean v
+      @@date1904 = v
+    end
 
     # Sets the date1904 attribute to the provided boolean
     # @return [Boolean]
-    def self.date1904=(v) Axlsx.validate_boolean v; @@date1904 = v; end
+    def self.date1904=(v)
+      Axlsx.validate_boolean v
+      @@date1904 = v
+    end
 
     # retrieves the date1904 attribute
     # @return [Boolean]
-    def self.date1904() @@date1904; end
+    def self.date1904
+      @@date1904
+    end
 
     # Whether to treat values starting with an equals sign as formulas or as literal strings.
     # Allowing user-generated data to be interpreted as formulas is a security risk.
@@ -280,10 +290,13 @@ module Axlsx
     #     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
+    attr_reader :use_autowidth
 
     # see @use_autowidth
-    def use_autowidth=(v = true) Axlsx.validate_boolean v; @use_autowidth = v; end
+    def use_autowidth=(v = true)
+      Axlsx.validate_boolean v
+      @use_autowidth = v
+    end
 
     # Font size of bold fonts is multiplied with this
     # Used for automatic calculation of cell widths with bold text

data/lib/axlsx/workbook/workbook_views.rb

@@ -5,7 +5,7 @@ module Axlsx
   class WorkbookViews < SimpleTypedList
     # creates the book views object
     def initialize
-      super WorkbookView
+      super(WorkbookView)
     end
 
     # Serialize to xml

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

@@ -43,7 +43,9 @@ module Axlsx
     # the filter button can be hidden, and not drawn.
     # @return [Boolean]
     def show_button
-      @show_button ||= true
+      return @show_button if defined?(@show_button)
+
+      true
     end
 
     # Flag indicating whether the AutoFilter button for this column is hidden.
@@ -83,7 +85,7 @@ module Axlsx
     # @return [Boolean]
     def show_button=(show)
       Axlsx.validate_boolean show
-      @show_botton = show
+      @show_button = show
     end
 
     # Serialize the object to xml

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

@@ -189,7 +189,9 @@ module Axlsx
     attr_reader :font_name
 
     # @see font_name
-    def font_name=(v) set_run_style :validate_string, :font_name, v; end
+    def font_name=(v)
+      set_run_style :validate_string, :font_name, v
+    end
 
     # The inline charset property for the cell
     # As far as I can tell, this is pretty much ignored. However, based on the spec it should be one of the following:
@@ -216,7 +218,9 @@ module Axlsx
     attr_reader :charset
 
     # @see charset
-    def charset=(v) set_run_style :validate_unsigned_int, :charset, v; end
+    def charset=(v)
+      set_run_style :validate_unsigned_int, :charset, v
+    end
 
     # The inline family property for the cell
     # @return [Integer]
@@ -237,49 +241,63 @@ module Axlsx
     attr_reader :b
 
     # @see b
-    def b=(v) set_run_style :validate_boolean, :b, v; end
+    def b=(v)
+      set_run_style :validate_boolean, :b, v
+    end
 
     # The inline italic property for the cell
     # @return [Boolean]
     attr_reader :i
 
     # @see i
-    def i=(v) set_run_style :validate_boolean, :i, v; end
+    def i=(v)
+      set_run_style :validate_boolean, :i, v
+    end
 
     # The inline strike property for the cell
     # @return [Boolean]
     attr_reader :strike
 
     # @see strike
-    def strike=(v) set_run_style :validate_boolean, :strike, v; end
+    def strike=(v)
+      set_run_style :validate_boolean, :strike, v
+    end
 
     # The inline outline property for the cell
     # @return [Boolean]
     attr_reader :outline
 
     # @see outline
-    def outline=(v) set_run_style :validate_boolean, :outline, v; end
+    def outline=(v)
+      set_run_style :validate_boolean, :outline, v
+    end
 
     # The inline shadow property for the cell
     # @return [Boolean]
     attr_reader :shadow
 
     # @see shadow
-    def shadow=(v) set_run_style :validate_boolean, :shadow, v; end
+    def shadow=(v)
+      set_run_style :validate_boolean, :shadow, v
+    end
 
     # The inline condense property for the cell
     # @return [Boolean]
     attr_reader :condense
 
     # @see condense
-    def condense=(v) set_run_style :validate_boolean, :condense, v; end
+    def condense=(v)
+      set_run_style :validate_boolean, :condense, v
+    end
 
     # The inline extend property for the cell
     # @return [Boolean]
     attr_reader :extend
 
     # @see extend
-    def extend=(v) set_run_style :validate_boolean, :extend, v; end
+    def extend=(v)
+      set_run_style :validate_boolean, :extend, v
+    end
 
     # The inline underline property for the cell.
     # It must be one of :none, :single, :double, :singleAccounting, :doubleAccounting
@@ -307,7 +325,9 @@ module Axlsx
     attr_reader :sz
 
     # @see sz
-    def sz=(v) set_run_style :validate_unsigned_int, :sz, v; end
+    def sz=(v)
+      set_run_style :validate_unsigned_int, :sz, v
+    end
 
     # The inline vertical alignment property for the cell
     # this must be one of [:baseline, :subscript, :superscript]

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

@@ -40,10 +40,16 @@ module Axlsx
     attr_reader :val
 
     # @see type
-    def type=(v); Axlsx.validate_conditional_formatting_value_object_type(v); @type = v end
+    def type=(v)
+      Axlsx.validate_conditional_formatting_value_object_type(v)
+      @type = v
+    end
 
     # @see gte
-    def gte=(v); Axlsx.validate_boolean(v); @gte = v end
+    def gte=(v)
+      Axlsx.validate_boolean(v)
+      @gte = v
+    end
 
     # @see val
     def val=(v)

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

@@ -7,7 +7,7 @@ module Axlsx
   class ColBreaks < SimpleTypedList
     # Instantiates a new list restricted to Break types
     def initialize
-      super Break
+      super(Break)
     end
 
     # A column break specific helper for adding a break.

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

@@ -7,7 +7,7 @@ module Axlsx
     def initialize(worksheet)
       raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
 
-      super Col
+      super(Col)
       @worksheet = worksheet
     end
 

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

@@ -61,9 +61,15 @@ module Axlsx
     end
 
     # @see rules
-    def rules=(v); @rules = v end
+    def rules=(v)
+      @rules = v
+    end
+
     # @see sqref
-    def sqref=(v); Axlsx.validate_string(v); @sqref = v end
+    def sqref=(v)
+      Axlsx.validate_string(v)
+      @sqref = v
+    end
 
     # Serializes the conditional formatting element
     # @example Conditional Formatting XML looks like: