caxlsx 4.0.0 → 4.2.0

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

@@ -56,7 +56,10 @@ module Axlsx
     attr_reader :interpolationPoints
 
     # @see iconSet
-    def iconSet=(v); Axlsx.validate_icon_set(v); @iconSet = v end
+    def iconSet=(v)
+      Axlsx.validate_icon_set(v)
+      @iconSet = v
+    end
 
     # @see interpolationPoints
     def interpolationPoints=(v)
@@ -66,13 +69,22 @@ module Axlsx
     end
 
     # @see showValue
-    def showValue=(v); Axlsx.validate_boolean(v); @showValue = v end
+    def showValue=(v)
+      Axlsx.validate_boolean(v)
+      @showValue = v
+    end
 
     # @see percent
-    def percent=(v); Axlsx.validate_boolean(v); @percent = v end
+    def percent=(v)
+      Axlsx.validate_boolean(v)
+      @percent = v
+    end
 
     # @see reverse
-    def reverse=(v); Axlsx.validate_boolean(v); @reverse = v end
+    def reverse=(v)
+      Axlsx.validate_boolean(v)
+      @reverse = v
+    end
 
     # Serialize this object to an xml string
     # @param [String] str
@@ -87,7 +99,7 @@ module Axlsx
 
     private
 
-    # Initalize the simple typed list of value objects
+    # Initialize the simple typed list of value objects
     def initialize_value_objects
       @value_objects = SimpleTypedList.new Cfvo
       @interpolationPoints.each { |point| @value_objects << Cfvo.new(type: :percent, val: point) }

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

@@ -8,7 +8,7 @@ module Axlsx
     def initialize(worksheet)
       raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
 
-      super String
+      super(String)
     end
 
     # adds cells to the merged cells collection

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

@@ -13,7 +13,7 @@ module Axlsx
                             :apply_styles
 
     # These attributes are all boolean so I'm doing a bit of a hand
-    # waving magic show to set up the attriubte accessors
+    # waving magic show to set up the attribute accessors
     boolean_attr_accessor :summary_below,
                           :summary_right,
                           :apply_styles

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

@@ -73,22 +73,45 @@ module Axlsx
       margins.select do |k, v|
         next unless MARGIN_KEYS.include? k
 
-        send("#{k}=", v)
+        send(:"#{k}=", v)
       end
     end
 
     # @see left
-    def left=(v); Axlsx.validate_unsigned_numeric(v); @left = v end
+    def left=(v)
+      Axlsx.validate_unsigned_numeric(v)
+      @left = v
+    end
+
     # @see right
-    def right=(v); Axlsx.validate_unsigned_numeric(v); @right = v end
+    def right=(v)
+      Axlsx.validate_unsigned_numeric(v)
+      @right = v
+    end
+
     # @see top
-    def top=(v); Axlsx.validate_unsigned_numeric(v); @top = v end
+    def top=(v)
+      Axlsx.validate_unsigned_numeric(v)
+      @top = v
+    end
+
     # @see bottom
-    def bottom=(v); Axlsx.validate_unsigned_numeric(v); @bottom = v end
+    def bottom=(v)
+      Axlsx.validate_unsigned_numeric(v)
+      @bottom = v
+    end
+
     # @see header
-    def header=(v); Axlsx.validate_unsigned_numeric(v); @header = v end
+    def header=(v)
+      Axlsx.validate_unsigned_numeric(v)
+      @header = v
+    end
+
     # @see footer
-    def footer=(v); Axlsx.validate_unsigned_numeric(v); @footer = v end
+    def footer=(v)
+      Axlsx.validate_unsigned_numeric(v)
+      @footer = v
+    end
 
     # Serializes the page margins element
     # @param [String] str

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

@@ -17,8 +17,7 @@ module Axlsx
 
     serializable_attributes :auto_page_breaks, :fit_to_page
 
-    attr_reader :auto_page_breaks
-    attr_reader :fit_to_page
+    attr_reader :auto_page_breaks, :fit_to_page
 
     # Flag indicating whether the Fit to Page print option is enabled.
     # @param [Boolean] value

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

@@ -38,13 +38,13 @@ module Axlsx
     # * verticalDpi
 
     # Number of vertical pages to fit on.
-    # @note PageSetup#fit_to is the recomended way to manage page fitting as only specifying one of fit_to_width/fit_to_height will result in the counterpart
+    # @note PageSetup#fit_to is the recommended way to manage page fitting as only specifying one of fit_to_width/fit_to_height will result in the counterpart
     # being set to 1.
     # @return [Integer]
     attr_reader :fit_to_height
 
     # Number of horizontal pages to fit on.
-    # @note PageSetup#fit_to is the recomended way to manage page fitting as only specifying one of width/height will result in the counterpart
+    # @note PageSetup#fit_to is the recommended way to manage page fitting as only specifying one of width/height will result in the counterpart
     # being set to 1.
     # @return [Integer]
     attr_reader :fit_to_width
@@ -198,17 +198,40 @@ module Axlsx
     end
 
     # @see fit_to_height
-    def fit_to_height=(v); Axlsx.validate_unsigned_int(v); @fit_to_height = v; end
+    def fit_to_height=(v)
+      Axlsx.validate_unsigned_int(v)
+      @fit_to_height = v
+    end
+
     # @see fit_to_width
-    def fit_to_width=(v); Axlsx.validate_unsigned_int(v); @fit_to_width = v; end
+    def fit_to_width=(v)
+      Axlsx.validate_unsigned_int(v)
+      @fit_to_width = v
+    end
+
     # @see orientation
-    def orientation=(v); Axlsx.validate_page_orientation(v); @orientation = v; end
+    def orientation=(v)
+      Axlsx.validate_page_orientation(v)
+      @orientation = v
+    end
+
     # @see paper_height
-    def paper_height=(v); Axlsx.validate_number_with_unit(v); @paper_height = v; end
+    def paper_height=(v)
+      Axlsx.validate_number_with_unit(v)
+      @paper_height = v
+    end
+
     # @see paper_width
-    def paper_width=(v); Axlsx.validate_number_with_unit(v); @paper_width = v; end
+    def paper_width=(v)
+      Axlsx.validate_number_with_unit(v)
+      @paper_width = v
+    end
+
     # @see scale
-    def scale=(v); Axlsx.validate_scale_10_400(v); @scale = v; end
+    def scale=(v)
+      Axlsx.validate_scale_10_400(v)
+      @scale = v
+    end
 
     # convenience method to achieve sanity when setting fit_to_width and fit_to_height
     # as they both default to 1 if only their counterpart is specified.
@@ -226,7 +249,7 @@ module Axlsx
     # @return [Boolean]
     def fit_to_page?
       # is there some better way to express this?
-      (!fit_to_width.nil? || !fit_to_height.nil?)
+      !fit_to_width.nil? || !fit_to_height.nil?
     end
 
     # Serializes the page settings element.

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

@@ -114,10 +114,16 @@ module Axlsx
     end
 
     # @see x_split
-    def x_split=(v); Axlsx.validate_unsigned_int(v); @x_split = v end
+    def x_split=(v)
+      Axlsx.validate_unsigned_int(v)
+      @x_split = v
+    end
 
     # @see y_split
-    def y_split=(v); Axlsx.validate_unsigned_int(v); @y_split = v end
+    def y_split=(v)
+      Axlsx.validate_unsigned_int(v)
+      @y_split = v
+    end
 
     # Serializes the data validation
     # @param [String] str

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

@@ -26,6 +26,7 @@ module Axlsx
       @pages = []
       @subtotal = nil
       @no_subtotals_on_headers = []
+      @grand_totals = :both
       @sort_on_headers = {}
       @style_info = {}
       parse_options options
@@ -51,6 +52,19 @@ module Axlsx
       @sort_on_headers = headers
     end
 
+    # Defines which Grand Totals are to be shown.
+    # @return [Symbol] The row and/or column Grand Totals that are to be shown.
+    # Defaults to `:both` to show both row & column grand totals.
+    # Set to `:row_only`, `:col_only`, or `:none` to hide one or both Grand Totals.
+    attr_reader :grand_totals
+
+    # (see #grand_totals)
+    def grand_totals=(value)
+      RestrictionValidator.validate "PivotTable.grand_totals", [:both, :row_only, :col_only, :none], value
+
+      @grand_totals = value
+    end
+
     # Style info for the pivot table
     # @return [Hash]
     attr_accessor :style_info
@@ -114,7 +128,8 @@ module Axlsx
       @columns = v
     end
 
-    # The data
+    # The data as an array of either headers (String) or hashes or mix of the two.
+    # Hash in format of { ref: header, num_fmt: numFmts, subtotal: subtotal }, where header is String, numFmts is Integer, and subtotal one of %w[sum count average max min product countNums stdDev stdDevp var varp]; leave subtotal blank to sum values
     # @return [Array]
     attr_reader :data
 
@@ -188,7 +203,11 @@ module Axlsx
     def to_xml_string(str = +'')
       str << '<?xml version="1.0" encoding="UTF-8"?>'
 
-      str << '<pivotTableDefinition xmlns="' << XML_NS << '" name="' << name << '" cacheId="' << cache_definition.cache_id.to_s << '"' << (data.size <= 1 ? ' dataOnRows="1"' : '') << ' applyNumberFormats="0" applyBorderFormats="0" applyFontFormats="0" applyPatternFormats="0" applyAlignmentFormats="0" applyWidthHeightFormats="1" dataCaption="Data" showMultipleLabel="0" showMemberPropertyTips="0" useAutoFormatting="1" indent="0" compact="0" compactData="0" gridDropZones="1" multipleFieldFilters="0">'
+      str << '<pivotTableDefinition xmlns="' << XML_NS << '" name="' << name << '" cacheId="' << cache_definition.cache_id.to_s << '"'
+      str << ' dataOnRows="1"' if data.size <= 1
+      str << ' rowGrandTotals="0"' if grand_totals == :col_only || grand_totals == :none
+      str << ' colGrandTotals="0"' if grand_totals == :row_only || grand_totals == :none
+      str << ' applyNumberFormats="0" applyBorderFormats="0" applyFontFormats="0" applyPatternFormats="0" applyAlignmentFormats="0" applyWidthHeightFormats="1" dataCaption="Data" showMultipleLabel="0" showMemberPropertyTips="0" useAutoFormatting="1" indent="0" compact="0" compactData="0" gridDropZones="1" multipleFieldFilters="0">'
 
       str << '<location firstDataCol="1" firstDataRow="1" firstHeaderRow="1" ref="' << ref << '"/>'
       str << '<pivotFields count="' << header_cells_count.to_s << '">'
@@ -244,8 +263,9 @@ module Axlsx
       unless data.empty?
         str << "<dataFields count=\"#{data.size}\">"
         data.each do |datum_value|
-          # The correct name prefix in ["Sum","Average", etc...]
-          str << "<dataField name='#{datum_value[:subtotal] || ''} of #{datum_value[:ref]}' fld='#{header_index_of(datum_value[:ref])}' baseField='0' baseItem='0'"
+          subtotal_name = datum_value[:subtotal] || 'sum'
+          subtotal_name = 'count' if name == 'countNums' # both count & countNums are labelled as count
+          str << "<dataField name='#{subtotal_name.capitalize} of #{datum_value[:ref]}' fld='#{header_index_of(datum_value[:ref])}' baseField='0' baseItem='0'"
           str << " numFmtId='#{datum_value[:num_fmt]}'" if datum_value[:num_fmt]
           str << " subtotal='#{datum_value[:subtotal]}' " if datum_value[:subtotal]
           str << "/>"
@@ -311,7 +331,11 @@ module Axlsx
       elsif columns.include? cell_ref
         attributes << 'axis="axisCol"'
         attributes << "sortType=\"#{sorttype == :descending ? 'descending' : 'ascending'}\"" if sorttype
-        include_items_tag = true
+        if subtotal
+          include_items_tag = true
+        else
+          attributes << 'defaultSubtotal="0"'
+        end
       elsif pages.include? cell_ref
         attributes << 'axis="axisPage"'
         include_items_tag = true

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

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

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

@@ -9,7 +9,7 @@ module Axlsx
     def initialize(worksheet)
       raise ArgumentError, 'You must provide a worksheet' unless worksheet.is_a?(Worksheet)
 
-      super ProtectedRange
+      super(ProtectedRange)
       @worksheet = worksheet
     end
 

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

@@ -29,7 +29,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:
@@ -56,7 +58,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]
@@ -77,55 +81,69 @@ 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, true
     # @return [Boolean]
     # @return [String]
-    # @note true is for backwards compatability and is reassigned to :single
+    # @note true is for backwards compatibility and is reassigned to :single
     attr_reader :u
 
     # @see u
@@ -148,7 +166,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/row.rb

@@ -143,7 +143,10 @@ module Axlsx
     private
 
     # assigns the owning worksheet for this row
-    def worksheet=(v) DataTypeValidator.validate :row_worksheet, Worksheet, v; @worksheet = v; end
+    def worksheet=(v)
+      DataTypeValidator.validate :row_worksheet, Worksheet, v
+      @worksheet = v
+    end
 
     # Converts values, types, and style options into cells and associates them with this row.
     # A new cell is created for each item in the values array.
@@ -160,7 +163,7 @@ module Axlsx
       types, style, formula_values, escape_formulas, offset = options.delete(:types), options.delete(:style), options.delete(:formula_values), options.delete(:escape_formulas), options.delete(:offset)
       offset.to_i.times { |index| self[index] = Cell.new(self) } if offset
       values.each_with_index do |value, index|
-        options[:style] = style.is_a?(Array) ? style[index] : style if style
+        options[:style] = (style.is_a?(Array) ? style[index] : style) || worksheet.column_info[index]&.style
         options[:type] = types.is_a?(Array) ? types[index] : types if types
         options[:escape_formulas] = escape_formulas.is_a?(Array) ? escape_formulas[index] : escape_formulas unless escape_formulas.nil?
         options[:formula_value] = formula_values[index] if formula_values.is_a?(Array)

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

@@ -5,7 +5,7 @@ module Axlsx
 
   class RowBreaks < SimpleTypedList
     def initialize
-      super Break
+      super(Break)
     end
 
     # Adds a row break

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

@@ -80,7 +80,10 @@ module Axlsx
     end
 
     # @see active_cell_id
-    def active_cell_id=(v); Axlsx.validate_unsigned_int(v); @active_cell_id = v end
+    def active_cell_id=(v)
+      Axlsx.validate_unsigned_int(v)
+      @active_cell_id = v
+    end
 
     # @see pane
     def pane=(v)
@@ -89,7 +92,10 @@ module Axlsx
     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 data validation
     # @param [String] str

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

@@ -18,7 +18,7 @@ module Axlsx
                             :sync_ref
 
     # These attributes are all boolean so I'm doing a bit of a hand
-    # waving magic show to set up the attriubte accessors
+    # waving magic show to set up the attribute accessors
     boolean_attr_accessor :sync_horizontal,
                           :sync_vertical,
                           :transition_evaluation,

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

@@ -106,7 +106,7 @@ module Axlsx
         char     = char.unpack1('c') << i # ord << i
         low_15   = char & 0x7fff
         high_15  = char & (0x7fff << 15)
-        high_15  = high_15 >> 15
+        high_15 >>= 15
         low_15 | high_15
       end
 

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

@@ -33,8 +33,8 @@ module Axlsx
     def initialize(options = {})
       # defaults
       @color_id = @top_left_cell = @pane = nil
-      @right_to_left = @show_formulas = @show_outline_symbols = @show_white_space = @tab_selected = @window_protection = false
-      @default_grid_color = @show_grid_lines = @show_row_col_headers = @show_ruler = @show_zeros = true
+      @right_to_left = @show_formulas = @show_white_space = @tab_selected = @window_protection = false
+      @default_grid_color = @show_grid_lines = @show_row_col_headers = @show_ruler = @show_zeros = @show_outline_symbols = true
       @zoom_scale = 100
       @zoom_scale_normal = @zoom_scale_page_layout_view = @zoom_scale_sheet_layout_view = @workbook_view_id = 0
       @selections = {}
@@ -162,7 +162,10 @@ module Axlsx
     end
 
     # @see color_id
-    def color_id=(v); Axlsx.validate_unsigned_int(v); @color_id = v end
+    def color_id=(v)
+      Axlsx.validate_unsigned_int(v)
+      @color_id = v
+    end
 
     # @see top_left_cell
     def top_left_cell=(v)
@@ -172,22 +175,40 @@ module Axlsx
     end
 
     # @see view
-    def view=(v); Axlsx.validate_sheet_view_type(v); @view = v end
+    def view=(v)
+      Axlsx.validate_sheet_view_type(v)
+      @view = v
+    end
 
     # @see workbook_view_id
-    def workbook_view_id=(v); Axlsx.validate_unsigned_int(v); @workbook_view_id = v end
+    def workbook_view_id=(v)
+      Axlsx.validate_unsigned_int(v)
+      @workbook_view_id = v
+    end
 
     # @see zoom_scale
-    def zoom_scale=(v); Axlsx.validate_scale_0_10_400(v); @zoom_scale = v end
+    def zoom_scale=(v)
+      Axlsx.validate_scale_0_10_400(v)
+      @zoom_scale = v
+    end
 
     # @see zoom_scale_normal
-    def zoom_scale_normal=(v); Axlsx.validate_scale_0_10_400(v); @zoom_scale_normal = v end
+    def zoom_scale_normal=(v)
+      Axlsx.validate_scale_0_10_400(v)
+      @zoom_scale_normal = v
+    end
 
     # @see zoom_scale_page_layout_view
-    def zoom_scale_page_layout_view=(v); Axlsx.validate_scale_0_10_400(v); @zoom_scale_page_layout_view = v end
+    def zoom_scale_page_layout_view=(v)
+      Axlsx.validate_scale_0_10_400(v)
+      @zoom_scale_page_layout_view = v
+    end
 
     # @see zoom_scale_sheet_layout_view
-    def zoom_scale_sheet_layout_view=(v); Axlsx.validate_scale_0_10_400(v); @zoom_scale_sheet_layout_view = v end
+    def zoom_scale_sheet_layout_view=(v)
+      Axlsx.validate_scale_0_10_400(v)
+      @zoom_scale_sheet_layout_view = v
+    end
 
     # Serializes the data validation
     # @param [String] str

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

@@ -34,14 +34,14 @@ module Axlsx
     # explicitly be disabled or all will show.
     def initialize_defaults
       %w(show_first_column show_last_column show_row_stripes show_column_stripes).each do |attr|
-        send("#{attr}=", 0)
+        send(:"#{attr}=", 0)
       end
     end
 
     # The name of the table style.
     attr_accessor :name
 
-    # seralizes this object to an xml string
+    # serializes this object to an xml string
     # @param [String] str the string to contact this objects serialization to.
     def to_xml_string(str = +'')
       serialized_tag('tableStyleInfo', str)

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

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