caxlsx 3.3.0 → 4.0.0

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

@@ -1,8 +1,8 @@
-module Axlsx
+# frozen_string_literal: true
 
+module Axlsx
   # A worksheet hyperlink object. Note that this is not the same as a drawing hyperlink object.
   class WorksheetHyperlink
-
     include Axlsx::OptionsParser
     include Axlsx::Accessors
     include Axlsx::SerializedAttributes
@@ -15,7 +15,7 @@ module Axlsx
     # @option [String] tooltip The tip to display when the user positions the mouse cursor over this hyperlink
     # @option [Symbol] target This is :external by default. If you set it to anything else, the location is interpreted to be the current workbook.
     # @option [String|Cell] ref The location of this hyperlink in the worksheet
-    def initialize(worksheet, options={})
+    def initialize(worksheet, options = {})
       DataTypeValidator.validate "Hyperlink.worksheet", [Worksheet], worksheet
       @worksheet = worksheet
       @target = :external
@@ -27,7 +27,7 @@ module Axlsx
 
     serializable_attributes :display, :tooltip, :ref
 
-    #Cell location of hyperlink on worksheet.
+    # Cell location of hyperlink on worksheet.
     # @return [String]
     attr_reader :ref
 
@@ -41,7 +41,7 @@ module Axlsx
     # @param [String|Cell] cell_reference The string reference or cell that defines where this hyperlink shows in the worksheet.
     def ref=(cell_reference)
       cell_reference = cell_reference.r if cell_reference.is_a?(Cell)
-      Axlsx::validate_string cell_reference
+      Axlsx.validate_string cell_reference
       @ref = cell_reference
     end
 
@@ -51,13 +51,14 @@ module Axlsx
     # @return [Relationship]
     def relationship
       return unless @target == :external
-      Relationship.new(self, HYPERLINK_R, location, :target_mode => :External)
+
+      Relationship.new(self, HYPERLINK_R, location, target_mode: :External)
     end
 
     # Seralize the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str='')
+    def to_xml_string(str = +'')
       str << '<hyperlink '
       serialized_attributes str, location_or_id
       str << '/>'
@@ -68,7 +69,7 @@ module Axlsx
     # r:id should only be specified for external targets.
     # @return [Hash]
     def location_or_id
-      @target == :external ?  { :"r:id" => relationship.Id } : { :location => Axlsx::coder.encode(location) }
+      @target == :external ? { "r:id": relationship.Id } : { location: Axlsx.coder.encode(location) }
     end
   end
 end

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

@@ -1,8 +1,8 @@
-module Axlsx
+# frozen_string_literal: true
 
-  #A collection of hyperlink objects for a worksheet
+module Axlsx
+  # A collection of hyperlink objects for a worksheet
   class WorksheetHyperlinks < SimpleTypedList
-
     # Creates a new Hyperlinks collection
     # @param [Worksheet] worksheet the worksheet that owns these hyperlinks
     def initialize(worksheet)
@@ -23,13 +23,15 @@ module Axlsx
     # @return Array
     def relationships
       return [] if empty?
-      map { |hyperlink| hyperlink.relationship }
+
+      map(&:relationship)
     end
 
     # seralize the collection of hyperlinks
     # @return [String]
-    def to_xml_string(str='')
+    def to_xml_string(str = +'')
       return if empty?
+
       str << '<hyperlinks>'
       each { |hyperlink| hyperlink.to_xml_string(str) }
       str << '</hyperlinks>'

data/lib/axlsx.rb

@@ -1,42 +1,41 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 require 'htmlentities'
-require 'axlsx/version.rb'
+require 'axlsx/version'
 require 'marcel'
 
-require 'axlsx/util/simple_typed_list.rb'
-require 'axlsx/util/constants.rb'
-require 'axlsx/util/validators.rb'
-require 'axlsx/util/accessors.rb'
+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.rb'
+require 'axlsx/stylesheet/styles'
 
-require 'axlsx/doc_props/app.rb'
-require 'axlsx/doc_props/core.rb'
-require 'axlsx/content_type/content_type.rb'
-require 'axlsx/rels/relationships.rb'
+require 'axlsx/doc_props/app'
+require 'axlsx/doc_props/core'
+require 'axlsx/content_type/content_type'
+require 'axlsx/rels/relationships'
 
-require 'axlsx/drawing/drawing.rb'
-require 'axlsx/workbook/workbook.rb'
-require 'axlsx/package.rb'
-#required gems
+require 'axlsx/drawing/drawing'
+require 'axlsx/workbook/workbook'
+require 'axlsx/package'
+# required gems
 require 'nokogiri'
 require 'zip'
 
-#core dependencies
+# core dependencies
 require 'bigdecimal'
+require 'cgi'
 require 'set'
 require 'time'
 
-begin
-  if Gem.loaded_specs.has_key?("axlsx_styler")
-    raise StandardError.new("Please remove `axlsx_styler` from your Gemfile, the associated functionality is now built-in to `caxlsx` directly.")
-  end
-rescue
-  # Do nothing
+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."
 end
 
 # xlsx generation with charts, images, automated column width, customizable styles
@@ -51,11 +50,11 @@ module Axlsx
   #
   # Defining as a class method on Axlsx to refrain from monkeypatching Object for all users of this gem.
   def self.instance_values_for(object)
-    Hash[object.instance_variables.map { |name| [name.to_s[1..-1], object.instance_variable_get(name)] }]
+    object.instance_variables.to_h { |name| [name.to_s[1..], object.instance_variable_get(name)] }
   end
 
   # determines the cell range for the items provided
-  def self.cell_range(cells, absolute=true)
+  def self.cell_range(cells, absolute = true)
     return "" unless cells.first.is_a? Cell
 
     first_cell, last_cell = cells.minmax_by(&:pos)
@@ -76,7 +75,7 @@ module Axlsx
     cells.sort_by(&:pos)
   end
 
-  #global reference html entity encoding
+  # global reference html entity encoding
   # @return [HtmlEntities]
   def self.coder
     @@coder ||= ::HTMLEntities.new
@@ -89,7 +88,7 @@ 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.reduce({ base: 1, i: 0 }) do |val, c|
       val[:i] += ((c.bytes.first - 64) * val[:base])
 
       val[:base] *= 26
@@ -103,37 +102,51 @@ module Axlsx
 
     row_index = (numbers_str.to_i - 1)
 
-    return [col_index, row_index]
+    [col_index, row_index]
   end
 
   # converts the column index into alphabetical values.
   # @note This follows the standard spreadsheet convention of naming columns A to Z, followed by AA to AZ etc.
   # @return [String]
   def self.col_ref(index)
-    chars = ''
-    while index >= 26 do
-      index, char = index.divmod(26)
-      chars.prepend((char + 65).chr)
-      index -= 1
+    # Every row will call this for each column / cell and so we can cache result and avoid lots of small object
+    # allocations.
+    @col_ref ||= {}
+    @col_ref[index] ||= begin
+      i = index
+      chars = +''
+      while i >= 26
+        i, char = i.divmod(26)
+        chars.prepend((char + 65).chr)
+        i -= 1
+      end
+      chars.prepend((i + 65).chr)
+      chars.freeze
     end
-    chars.prepend((index + 65).chr)
-    chars
+  end
+
+  # converts the row index into string values.
+  # @note The spreadsheet rows are 1-based and the passed in index is 0-based, so we add 1.
+  # @return [String]
+  def self.row_ref(index)
+    @row_ref ||= {}
+    @row_ref[index] ||= (index + 1).to_s.freeze
   end
 
   # @return [String] The alpha(column)numeric(row) reference for this sell.
   # @example Relative Cell Reference
   #   ws.rows.first.cells.first.r #=> "A1"
   def self.cell_r(c_index, r_index)
-    col_ref(c_index) << (r_index+1).to_s
+    col_ref(c_index) + row_ref(r_index)
   end
 
-  # Creates an array of individual cell references based on an excel reference range.
+  # Creates an array of individual cell references based on an Excel reference range.
   # @param [String] range A cell range, for example A1:D5
   # @return [Array]
   def self.range_to_a(range)
-    range.match(/^(\w+?\d+)\:(\w+?\d+)$/)
-    start_col, start_row = name_to_indices($1)
-    end_col,   end_row   = name_to_indices($2)
+    range =~ /^(\w+?\d+):(\w+?\d+)$/
+    start_col, start_row = name_to_indices(::Regexp.last_match(1))
+    end_col,   end_row   = name_to_indices(::Regexp.last_match(2))
     (start_row..end_row).to_a.map do |row_num|
       (start_col..end_col).to_a.map do |col_num|
         cell_r(col_num, row_num)
@@ -144,10 +157,10 @@ module Axlsx
   # performs the increadible 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)
+  def self.camel(s = "", all_caps = true)
     s = s.to_s
     s = s.capitalize if all_caps
-    s.gsub(/_(.)/){ $1.upcase }
+    s.gsub(/_(.)/) { ::Regexp.last_match(1).upcase }
   end
 
   # returns the provided string with all invalid control charaters
@@ -168,18 +181,18 @@ module Axlsx
   # @param [Object] value The value to process
   # @return [Object]
   def self.booleanize(value)
-    if value == true || value == false
-      value ? 1 : 0
+    if BOOLEAN_VALUES.include?(value)
+      value ? '1' : '0'
     else
       value
     end
   end
 
   # utility method for performing a deep merge on a Hash
-  # @param [Hash] Hash to merge into
-  # @param [Hash] Hash to be added
+  # @param [Hash] first_hash Hash to merge into
+  # @param [Hash] second_hash Hash to be added
   def self.hash_deep_merge(first_hash, second_hash)
-    first_hash.merge(second_hash) do |key, this_val, other_val|
+    first_hash.merge(second_hash) do |_key, this_val, other_val|
       if this_val.is_a?(Hash) && other_val.is_a?(Hash)
         Axlsx.hash_deep_merge(this_val, other_val)
       else
@@ -190,7 +203,7 @@ module Axlsx
 
   # Instructs the serializer to not try to escape cell value input.
   # This will give you a huge speed bonus, but if you content has <, > or other xml character data
-  # the workbook will be invalid and excel will complain.
+  # the workbook will be invalid and Excel will complain.
   def self.trust_input
     @trust_input ||= false
   end
@@ -201,4 +214,19 @@ module Axlsx
   def self.trust_input=(trust_me)
     @trust_input = trust_me
   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.
+  # See https://www.owasp.org/index.php/CSV_Injection for details.
+  # @return [Boolean]
+  def self.escape_formulas
+    !defined?(@escape_formulas) || @escape_formulas.nil? ? true : @escape_formulas
+  end
+
+  # Sets whether to treat values starting with an equals sign as formulas or as literal strings.
+  # @param [Boolean] value The value to set.
+  def self.escape_formulas=(value)
+    Axlsx.validate_boolean(value)
+    @escape_formulas = value
+  end
 end

data/lib/caxlsx.rb

@@ -1,2 +1,3 @@
-# encoding: UTF-8
-require 'axlsx.rb'
+# frozen_string_literal: true
+
+require 'axlsx'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caxlsx
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Randy Morgan
@@ -9,131 +9,133 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-21 00:00:00.000000000 Z
+date: 2023-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: htmlentities
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '4.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.4
+        version: 4.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '4.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.4
+        version: 4.3.4
 - !ruby/object:Gem::Dependency
-  name: rubyzip
+  name: marcel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: htmlentities
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '1.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.3.4
+        version: 1.10.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '1.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.3.4
+        version: 1.10.4
 - !ruby/object:Gem::Dependency
-  name: marcel
+  name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.8
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.8
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: kramdown
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
-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)
+        version: 0.9.8
+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)
   without having to understand the entire ECMA specification. Check out the README
   for some examples of how easy it is. Best of all, you can validate your xlsx file
   before serialization so you know for sure that anything generated is going to load
-  on your client's machine.\n"
+  on your client''s machine.
+
+  '
 email: noel@peden.biz
 executables: []
 extensions: []
@@ -218,6 +220,7 @@ files:
 - lib/axlsx/stylesheet/table_styles.rb
 - lib/axlsx/stylesheet/xf.rb
 - lib/axlsx/util/accessors.rb
+- lib/axlsx/util/buffered_zip_output_stream.rb
 - lib/axlsx/util/constants.rb
 - lib/axlsx/util/mime_type_utils.rb
 - lib/axlsx/util/options_parser.rb
@@ -236,6 +239,8 @@ files:
 - lib/axlsx/workbook/worksheet/auto_filter/auto_filter.rb
 - lib/axlsx/workbook/worksheet/auto_filter/filter_column.rb
 - lib/axlsx/workbook/worksheet/auto_filter/filters.rb
+- lib/axlsx/workbook/worksheet/auto_filter/sort_condition.rb
+- lib/axlsx/workbook/worksheet/auto_filter/sort_state.rb
 - lib/axlsx/workbook/worksheet/border_creator.rb
 - lib/axlsx/workbook/worksheet/break.rb
 - lib/axlsx/workbook/worksheet/cell.rb
@@ -328,7 +333,8 @@ files:
 homepage: https://github.com/caxlsx/caxlsx
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -337,14 +343,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Excel OOXML (xlsx) with charts, styles, images and autowidth columns.