caxlsx 4.1.0 → 4.3.0

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Axlsx
-  # A simple, self serializing class for storing conditional formattings
+  # A simple, self serializing class for storing conditional formatting
   class ConditionalFormattings < SimpleTypedList
     # creates a new Tables object
     def initialize(worksheet)
@@ -15,7 +15,7 @@ module Axlsx
     # @return [Worksheet]
     attr_reader :worksheet
 
-    # serialize the conditional formattings
+    # serialize the conditional formatting
     def to_xml_string(str = +'')
       return if empty?
 

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

@@ -278,7 +278,7 @@ module Axlsx
 
       str << '<dataValidation '
       h.each_with_index do |key_value, index|
-        str << ' ' unless index.zero?
+        str << ' ' unless index == 0
         str << key_value.first << '="' << Axlsx.booleanize(key_value.last).to_s << '"'
       end
       str << '>'

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Axlsx
-  # A simple, self serializing class for storing conditional formattings
+  # A simple, self serializing class for storing conditional formatting
   class DataValidations < SimpleTypedList
     # creates a new Tables object
     def initialize(worksheet)
@@ -15,7 +15,7 @@ module Axlsx
     # @return [Worksheet]
     attr_reader :worksheet
 
-    # serialize the conditional formattings
+    # serialize the conditional formatting
     def to_xml_string(str = +'')
       return if empty?
 

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

@@ -3,9 +3,9 @@
 require "date"
 
 module Axlsx
-  # The DateTimeConverter class converts both data and time types to their apprpriate Excel serializations
+  # The DateTimeConverter class converts both data and time types to their appropriate Excel serializations
   class DateTimeConverter
-    # The date_to_serial method converts Date objects to the equivelant Excel serialized forms
+    # The date_to_serial method converts Date objects to the equivalent Excel serialized forms
     # @param [Date] date the date to be serialized
     # @return [Numeric]
     def self.date_to_serial(date)

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

@@ -28,7 +28,7 @@ module Axlsx
 
     attr_reader :worksheet
 
-    # the full refernece for this dimension
+    # the full reference for this dimension
     # @return [String]
     def sqref
       "#{first_cell_reference}:#{last_cell_reference}"

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

@@ -7,7 +7,7 @@ module Axlsx
   # of plain text and control characters. A fairly comprehensive list of control
   # characters can be found here:
   # https://github.com/randym/axlsx/blob/master/notes_on_header_footer.md
-  #     
+  #
   # @note The recommended way of managing header/footers is via Worksheet#header_footer
   # @see Worksheet#initialize
   class HeaderFooter

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

@@ -99,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/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_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

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

@@ -8,6 +8,7 @@ module Axlsx
   class Pane
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
+
     # Creates a new {Pane} object
     # @option options [Symbol] active_pane Active Pane
     # @option options [Symbol] state Split State

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
@@ -319,7 +343,7 @@ module Axlsx
         attributes << 'dataField="1"'
       end
 
-      "<pivotField #{attributes.join(' ')}>#{include_items_tag ? items_tag : nil}</pivotField>"
+      "<pivotField #{attributes.join(' ')}>#{items_tag if include_items_tag}</pivotField>"
     end
 
     def data_refs

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

@@ -10,6 +10,7 @@ module Axlsx
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
     include Axlsx::Accessors
+
     # Creates a new PrintOptions object
     # @option options [Boolean] grid_lines Whether grid lines should be printed
     # @option options [Boolean] headings Whether row and column headings should be printed

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

@@ -143,7 +143,7 @@ module Axlsx
     # 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

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

@@ -7,6 +7,7 @@ module Axlsx
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
     include Axlsx::Accessors
+
     # creates a new SheetCalcPr
     # @param [Hash] options Options for this object
     # @option [Boolean] full_calc_on_load @see full_calc_on_load

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/table_style_info.rb

@@ -7,6 +7,7 @@ module Axlsx
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
     include Axlsx::Accessors
+
     # creates a new TableStyleInfo instance
     # @param [Hash] options
     # @option [Boolean] show_first_column indicates if the first column should
@@ -41,7 +42,7 @@ module Axlsx
     # 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/worksheet.rb

@@ -31,7 +31,7 @@ module Axlsx
 
     serializable_attributes :sheet_id, :state
 
-    # Initalizes page margin, setup and print options
+    # Initializes page margin, setup and print options
     # @param [Hash] options Options passed in from the initializer
     def initialize_page_options(options)
       @page_margins = PageMargins.new options[:page_margins] if options[:page_margins]
@@ -181,7 +181,7 @@ module Axlsx
       @auto_filter ||= AutoFilter.new self
     end
 
-    # Indicates if the worksheet will be fit by witdh or height to a specific number of pages.
+    # Indicates if the worksheet will be fit by width or height to a specific number of pages.
     # To alter the width or height for page fitting, please use page_setup.fit_to_widht or page_setup.fit_to_height.
     # If you want the worksheet to fit on more pages (e.g. 2x2), set {PageSetup#fit_to_width} and {PageSetup#fit_to_height} accordingly.
     # @return Boolean
@@ -421,7 +421,7 @@ module Axlsx
     # @option options [Array] values
     # @option options [Array, Symbol] types
     # @option options [Array, Integer] style
-    # @option options [Array] widths each member of the widths array will affect how auto_fit behavies.
+    # @option options [Array] widths each member of the widths array will affect how auto_fit behaves.
     # @option options [Float] height the row's height (in points)
     # @option options [Integer] offset - add empty columns before values
     # @option options [Array, Boolean] escape_formulas - Whether to treat a value starting with an equal
@@ -666,12 +666,11 @@ module Axlsx
     # @return [Relationships]
     def relationships
       r = Relationships.new
-      r + [tables.relationships,
-           worksheet_comments.relationships,
-           hyperlinks.relationships,
-           worksheet_drawing.relationship,
-           pivot_tables.relationships].flatten.compact || []
-      r
+      r.concat [tables.relationships,
+                worksheet_comments.relationships,
+                hyperlinks.relationships,
+                worksheet_drawing.relationship,
+                pivot_tables.relationships].flatten.compact
     end
 
     # Returns the cell or cells defined using Excel style A1:B3 references.
@@ -728,7 +727,7 @@ module Axlsx
     end
 
     # shortcut level to specify the outline level for a series of rows
-    # Oulining is what lets you add collapse and expand to a data set.
+    # Outlining is what lets you add collapse and expand to a data set.
     # @param [Integer] start_index The zero based index of the first row of outlining.
     # @param [Integer] end_index The zero based index of  the last row to be outlined
     # @param [integer] level The level of outline to apply
@@ -738,7 +737,7 @@ module Axlsx
     end
 
     # shortcut level to specify the outline level for a series of columns
-    # Oulining is what lets you add collapse and expand to a data set.
+    # Outlining is what lets you add collapse and expand to a data set.
     # @param [Integer] start_index The zero based index of the first column of outlining.
     # @param [Integer] end_index The zero based index of  the last column to be outlined
     # @param [integer] level The level of outline to apply
@@ -855,7 +854,6 @@ module Axlsx
       cells.each_with_index do |cell, index|
         width = widths ? widths[index] : nil
         col = find_or_create_column_info(index)
-        next if width == :ignore
 
         col.update_width(cell, width, workbook.use_autowidth)
       end

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module Axlsx
-  # A wraper class for comments that defines its on worksheet
-  # serailization
+  # A wrapper class for comments that defines its on worksheet
+  # serialization
   class WorksheetComments
     # Creates a new WorksheetComments object
-    # param [Worksheet] worksheet The worksheet comments in thes object belong to
+    # param [Worksheet] worksheet The worksheet to which the comments belong
     def initialize(worksheet)
       raise ArugumentError, 'You must provide a worksheet' unless worksheet.is_a?(Worksheet)
 
@@ -37,7 +37,7 @@ module Axlsx
 
     # Helper method to tell us if there are comments in the comments collection
     # @return [Boolean]
-    def has_comments? # rubocop:disable Naming/PredicateName
+    def has_comments? # rubocop:disable Naming/PredicatePrefix
       !comments.empty?
     end
 

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

@@ -42,7 +42,7 @@ module Axlsx
 
     # helper method to tell us if the drawing has something in it or not
     # @return [Boolean]
-    def has_drawing? # rubocop:disable Naming/PredicateName
+    def has_drawing? # rubocop:disable Naming/PredicatePrefix
       @drawing.is_a? Drawing
     end
 

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

@@ -6,6 +6,7 @@ module Axlsx
     include Axlsx::OptionsParser
     include Axlsx::Accessors
     include Axlsx::SerializedAttributes
+
     # Creates a new hyperlink object.
     # @note the preferred way to add hyperlinks to your worksheet is the Worksheet#add_hyperlink method
     # @param [Worksheet] worksheet the Worksheet that owns this hyperlink
@@ -55,7 +56,7 @@ module Axlsx
       Relationship.new(self, HYPERLINK_R, location, target_mode: :External)
     end
 
-    # Seralize the object
+    # Serialize the object
     # @param [String] str
     # @return [String]
     def to_xml_string(str = +'')

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

@@ -27,7 +27,7 @@ module Axlsx
       map(&:relationship)
     end
 
-    # seralize the collection of hyperlinks
+    # serialize the collection of hyperlinks
     # @return [String]
     def to_xml_string(str = +'')
       return if empty?

data/lib/axlsx.rb

@@ -1,38 +1,39 @@
 # frozen_string_literal: true
 
+require_relative 'axlsx/version'
+
+# gemspec dependencies
 require 'htmlentities'
-require 'axlsx/version'
 require 'marcel'
-
-require 'axlsx/util/simple_typed_list'
-require 'axlsx/util/constants'
-require 'axlsx/util/validators'
-require 'axlsx/util/accessors'
-require 'axlsx/util/serialized_attributes'
-require 'axlsx/util/options_parser'
-require 'axlsx/util/mime_type_utils'
-require 'axlsx/util/buffered_zip_output_stream'
-require 'axlsx/util/zip_command'
-
-require 'axlsx/stylesheet/styles'
-
-require 'axlsx/doc_props/app'
-require 'axlsx/doc_props/core'
-require 'axlsx/content_type/content_type'
-require 'axlsx/rels/relationships'
-
-require 'axlsx/drawing/drawing'
-require 'axlsx/workbook/workbook'
-require 'axlsx/package'
-# required gems
 require 'nokogiri'
 require 'zip'
 
-# core dependencies
-require 'bigdecimal'
+# Ruby core dependencies
 require 'cgi'
 require 'set'
 require 'time'
+require 'uri'
+
+require_relative 'axlsx/util/simple_typed_list'
+require_relative 'axlsx/util/constants'
+require_relative 'axlsx/util/validators'
+require_relative 'axlsx/util/accessors'
+require_relative 'axlsx/util/serialized_attributes'
+require_relative 'axlsx/util/options_parser'
+require_relative 'axlsx/util/mime_type_utils'
+require_relative 'axlsx/util/buffered_zip_output_stream'
+require_relative 'axlsx/util/zip_command'
+
+require_relative 'axlsx/stylesheet/styles'
+
+require_relative 'axlsx/doc_props/app'
+require_relative 'axlsx/doc_props/core'
+require_relative 'axlsx/content_type/content_type'
+require_relative 'axlsx/rels/relationships'
+
+require_relative 'axlsx/drawing/drawing'
+require_relative 'axlsx/workbook/workbook'
+require_relative 'axlsx/package'
 
 if Gem.loaded_specs.key?("axlsx_styler")
   raise StandardError, "Please remove `axlsx_styler` from your Gemfile, the associated functionality is now built-in to `caxlsx` directly."
@@ -88,12 +89,10 @@ module Axlsx
     letters_str = name[/[A-Z]+/]
 
     # capitalization?!?
-    v = letters_str.reverse.chars.reduce({ base: 1, i: 0 }) do |val, c|
+    v = letters_str.reverse.chars.each_with_object({ base: 1, i: 0 }) do |c, val|
       val[:i] += ((c.bytes.first - 64) * val[:base])
 
       val[:base] *= 26
-
-      next val
     end
 
     col_index = (v[:i] - 1)
@@ -154,7 +153,7 @@ module Axlsx
     end
   end
 
-  # performs the increadible feat of changing snake_case to CamelCase
+  # performs the incredible feat of changing snake_case to CamelCase
   # @param [String] s The snake case string to camelize
   # @return [String]
   def self.camel(s = "", all_caps = true)
@@ -163,7 +162,7 @@ module Axlsx
     s.gsub(/_(.)/) { ::Regexp.last_match(1).upcase }
   end
 
-  # returns the provided string with all invalid control charaters
+  # returns the provided string with all invalid control characters
   # removed.
   # @param [String] str The string to process
   # @return [String]
@@ -229,4 +228,19 @@ module Axlsx
     Axlsx.validate_boolean(value)
     @escape_formulas = value
   end
+
+  # Returns a URI parser instance, preferring RFC2396_PARSER if available,
+  # otherwise falling back to DEFAULT_PARSER. This method ensures consistent
+  # URI parsing across different Ruby versions.
+  # This method can be removed when dropping compatibility for Ruby < 3.4
+  # See https://github.com/ruby/uri/pull/114 for details.
+  # @return [Object]
+  def self.uri_parser
+    @uri_parser ||=
+      if defined?(URI::RFC2396_PARSER)
+        URI::RFC2396_PARSER
+      else
+        URI::DEFAULT_PARSER
+      end
+  end
 end

data/lib/caxlsx.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'axlsx'
+require_relative 'axlsx'

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caxlsx
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Randy Morgan
 - Jurriaan Pruis
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -71,20 +70,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '2.4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '2.4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 description: 'xlsx spreadsheet generation with charts, images, automated column width,
   customizable styles and full schema validation. Axlsx helps you create beautiful
   Office Open XML Spreadsheet documents (Excel, Google Spreadsheets, Numbers, LibreOffice)
@@ -297,7 +296,6 @@ metadata:
   changelog_uri: https://github.com/caxlsx/caxlsx/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/caxlsx/caxlsx
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -312,8 +310,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Excel OOXML (xlsx) with charts, styles, images and autowidth columns.
 test_files: []