caxlsx 4.0.0 → 4.4.1

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/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/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_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/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

@@ -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
@@ -34,14 +35,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
 

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

@@ -31,11 +31,11 @@ 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]
-      @page_setup = PageSetup.new options[:page_setup]  if options[:page_setup]
+      @page_setup = PageSetup.new options[:page_setup] if options[:page_setup]
       @print_options = PrintOptions.new options[:print_options] if options[:print_options]
       @header_footer = HeaderFooter.new options[:header_footer] if options[:header_footer]
       @row_breaks = RowBreaks.new
@@ -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
@@ -552,6 +552,19 @@ module Axlsx
       end
     end
 
+    # This is a helper method that lets you specify a default style for multiple columns in a worksheet in one go.
+    # This style will be applied for all not-yet-defined cells in a column.
+    # Note that you must call column_styles BEFORE adding data, otherwise the styles will not be set successfully for new cells.
+    # @param [Integer] styles the cellXfs indexes
+    def column_styles(*styles)
+      styles.each_with_index do |style, index|
+        next if style.nil?
+
+        Axlsx.validate_unsigned_int(style)
+        find_or_create_column_info(index).style = style
+      end
+    end
+
     # Set the style for cells in a specific column
     # @param [Integer] index the index of the column
     # @param [Integer] style the cellXfs index
@@ -653,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.
@@ -715,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
@@ -725,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
@@ -833,13 +845,15 @@ module Axlsx
       @worksheet_comments ||= WorksheetComments.new self
     end
 
-    def workbook=(v) DataTypeValidator.validate "Worksheet.workbook", Workbook, v; @workbook = v; end
+    def workbook=(v)
+      DataTypeValidator.validate "Worksheet.workbook", Workbook, v
+      @workbook = v
+    end
 
     def update_column_info(cells, widths = nil)
       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,12 +56,12 @@ 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 = +'')
       str << '<hyperlink '
-      serialized_attributes str, location_or_id
+      serialized_attributes str, location_or_id, false
       str << '/>'
     end
 

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

@@ -8,7 +8,7 @@ module Axlsx
     def initialize(worksheet)
       DataTypeValidator.validate "Hyperlinks.worksheet", [Worksheet], worksheet
       @worksheet = worksheet
-      super WorksheetHyperlink
+      super(WorksheetHyperlink)
     end
 
     # Creates and adds a new hyperlink based on the options provided
@@ -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,41 @@
 # 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 'net/http'
+
+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/uri_utils'
+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 +91,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 +155,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 +164,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 +230,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'