caxlsx 4.0.0 → 4.4.1

data/lib/axlsx/util/buffered_zip_output_stream.rb

@@ -9,6 +9,10 @@ module Axlsx
     # The 4_096 was chosen somewhat arbitrary, however, it was difficult to see any obvious improvement with larger
     # buffer sizes.
     BUFFER_SIZE = 4_096
+    # The suppress_extra_fields method was introduced in rubyzip 3.2
+    # Between rubyzip 3.0 and 3.2, it automatically writes zip64 support to the xlsx files
+    # See: https://github.com/caxlsx/caxlsx/issues/481
+    SUPPRESS_ZIP64 = Zip::OutputStream.method(:open).parameters.any? { |_, key| key == :suppress_extra_fields } ? { suppress_extra_fields: :zip64 } : {}
 
     def initialize(zos)
       @zos = zos
@@ -19,7 +23,7 @@ module Axlsx
     #
     # The directory and its contents are removed at the end of the block.
     def self.open(file_name, encrypter = nil)
-      Zip::OutputStream.open(file_name, encrypter) do |zos|
+      Zip::OutputStream.open(file_name, encrypter: encrypter, **SUPPRESS_ZIP64) do |zos|
         bzos = new(zos)
         yield(bzos)
       ensure
@@ -28,7 +32,7 @@ module Axlsx
     end
 
     def self.write_buffer(io = ::StringIO.new, encrypter = nil)
-      Zip::OutputStream.write_buffer(io, encrypter) do |zos|
+      Zip::OutputStream.write_buffer(io, encrypter: encrypter, **SUPPRESS_ZIP64) do |zos|
         bzos = new(zos)
         yield(bzos)
       ensure

data/lib/axlsx/util/constants.rb

@@ -79,6 +79,9 @@ module Axlsx
   # shared strings namespace
   SHARED_STRINGS_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings"
 
+  # theme rels namespace
+  THEME_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme"
+
   # drawing rels namespace
   DRAWING_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing"
 
@@ -133,6 +136,9 @@ module Axlsx
   # shared strings content type
   SHARED_STRINGS_CT = "application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml"
 
+  # theme content type
+  THEME_CT = "application/vnd.openxmlformats-officedocument.theme+xml"
+
   # core content type
   CORE_CT = "application/vnd.openxmlformats-package.core-properties+xml"
 
@@ -187,6 +193,9 @@ module Axlsx
   # shared_strings  part
   SHARED_STRINGS_PN = "sharedStrings.xml"
 
+  # theme part
+  THEME_PN = "theme/theme1.xml"
+
   # app part
   APP_PN = "docProps/app.xml"
 
@@ -259,7 +268,10 @@ module Axlsx
   # drawing validation schema
   DRAWING_XSD = "#{SCHEMA_BASE}dml-spreadsheetDrawing.xsd"
 
-  # number format id for pecentage formatting using the default formatting id.
+  # theme validation schema
+  THEME_XSD = "#{SCHEMA_BASE}dml-main.xsd"
+
+  # number format id for percentage formatting using the default formatting id.
   NUM_FMT_PERCENT = 9
 
   # number format id for date format like 2011/11/13
@@ -404,7 +416,7 @@ module Axlsx
   CONTROL_CHARS = pattern.freeze
 
   # ISO 8601 date recognition
-  ISO_8601_REGEX = /\A(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?\Z/.freeze
+  ISO_8601_REGEX = /\A(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?\Z/.freeze
 
   # FLOAT recognition
   SAFE_FLOAT_REGEX = /\A[-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]{1,2})?\Z/.freeze

data/lib/axlsx/util/mime_type_utils.rb

@@ -1,22 +1,81 @@
 # frozen_string_literal: true
 
-require 'open-uri'
-
 module Axlsx
   # This module defines some utils related with mime type detection
   module MimeTypeUtils
-    # Detect a file mime type
-    # @param [String] v File path
-    # @return [String] File mime type
-    def self.get_mime_type(v)
-      Marcel::MimeType.for(Pathname.new(v))
-    end
+    # Extension to MIME type mapping for Windows fallback
+    EXTENSION_FALLBACKS = {
+      '.jpg' => 'image/jpeg',
+      '.jpeg' => 'image/jpeg',
+      '.png' => 'image/png',
+      '.gif' => 'image/gif'
+    }.freeze
+
+    class << self
+      # Detect a file mime type
+      # @param [String] v File path
+      # @return [String] File mime type
+      def get_mime_type(v)
+        mime_type = Marcel::MimeType.for(Pathname.new(v))
+
+        # Windows fallback: Marcel sometimes returns application/octet-stream for valid image files
+        if mime_type == 'application/octet-stream' && windows_platform?
+          extension = File.extname(v).downcase
+          # Verify it's actually an image by checking the file header
+          if EXTENSION_FALLBACKS.key?(extension) && File.exist?(v) && valid_image_file?(v, extension)
+            mime_type = EXTENSION_FALLBACKS[extension]
+          end
+        end
+
+        mime_type
+      end
+
+      # Detect a file mime type from URI
+      # @param [String] v URI
+      # @return [String] File mime type
+      def get_mime_type_from_uri(v)
+        uri = URI.parse(v)
+
+        unless uri.is_a?(URI::HTTP) || uri.is_a?(URI::HTTPS)
+          raise URI::InvalidURIError, "Only HTTP/HTTPS URIs are supported"
+        end
+
+        response = UriUtils.fetch_headers(uri)
+        mime_type = response&.[]('content-type')&.split(';')&.first&.strip
+
+        if mime_type.nil? || mime_type.empty?
+          raise ArgumentError, "Unable to determine MIME type from response"
+        end
+
+        mime_type
+      end
+
+      private
+
+      def windows_platform?
+        RUBY_PLATFORM =~ /mswin|mingw|cygwin/
+      end
+
+      def valid_image_file?(file_path, extension)
+        return false unless File.exist?(file_path)
 
-    # Detect a file mime type from URI
-    # @param [String] v URI
-    # @return [String] File mime type
-    def self.get_mime_type_from_uri(v)
-      Marcel::MimeType.for(URI.parse(v).open)
+        # Check magic bytes for common image formats
+        begin
+          header = File.binread(file_path, 10)
+          case extension
+          when '.jpg', '.jpeg'
+            header[0..2].bytes == [0xFF, 0xD8, 0xFF] # JPEG magic bytes
+          when '.png'
+            header[0..7].bytes == [0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A] # PNG magic bytes
+          when '.gif'
+            header[0..2] == 'GIF' # GIF magic bytes
+          else
+            false
+          end
+        rescue StandardError
+          false
+        end
+      end
     end
   end
 end

data/lib/axlsx/util/serialized_attributes.rb

@@ -91,8 +91,8 @@ module Axlsx
 
     # serialized instance values at text nodes on a camelized element of the
     # attribute name. You may pass in a block for evaluation against non nil
-    # values. We use an array for element attributes becuase misordering will
-    # break the xml and 1.8.7 does not support ordered hashes.
+    # values. We use an array for element attributes because misordering will
+    # break the xml.
     # @param [String] str The string instance to which serialized data is appended
     # @param [Array] additional_attributes An array of additional attribute names.
     # @return [String] The serialized output.

data/lib/axlsx/util/simple_typed_list.rb

@@ -21,7 +21,7 @@ module Axlsx
     alias :== :equal?
     alias :eql? :equal?
 
-    # Creats a new typed list
+    # Creates a new typed list
     # @param [Array, Class] type An array of Class objects or a single Class object
     # @param [String] serialize_as The tag name to use in serialization
     # @raise [ArgumentError] if all members of type are not Class objects
@@ -57,7 +57,7 @@ module Axlsx
     # Transposes the list (without blowing up like ruby does)
     # any non populated cell in the matrix will be a nil value
     def transpose
-      return clone if size.zero?
+      return clone if size == 0
 
       row_count = size
       max_column_count = map { |row| row.cells.size }.max
@@ -90,21 +90,24 @@ module Axlsx
       self
     end
 
-    # join operator
-    # @param [Array] other the array to join
+    # Appends the elements of +others+ to self.
+    # @param [Array<Array>] others one or more arrays to join
     # @raise [ArgumentError] if any of the values being joined are not
     # one of the allowed types
     # @return [SimpleTypedList]
-    def +(other)
-      other.each do |item|
-        self << item
+    def concat(*others)
+      others.each do |other|
+        other.each do |item|
+          self << item
+        end
       end
-      super
+      self
     end
 
-    # Concat operator
+    # Pushes the given object on to the end of this array and returns the index
+    # of the item added.
     # @param [Any] v the data to be added
-    # @raise [ArgumentError] if the value being added is not one fo the allowed types
+    # @raise [ArgumentError] if the value being added is not one of the allowed types
     # @return [Integer] returns the index of the item added.
     def <<(v)
       DataTypeValidator.validate :SimpleTypedList_push, @allowed_types, v
@@ -112,7 +115,17 @@ module Axlsx
       size - 1
     end
 
-    alias :push :<<
+    # Pushes the given object(s) on to the end of this array. This expression
+    # returns the array itself, so several appends may be chained together.
+    # @param [Any] values the data to be added
+    # @raise [ArgumentError] if any of the values being joined are not
+    # @return [SimpleTypedList]
+    def push(*values)
+      values.each do |value|
+        self << value
+      end
+      self
+    end
 
     # delete the item from the list
     # @param [Any] v The item to be deleted.
@@ -147,7 +160,7 @@ module Axlsx
       super
     end
 
-    # inserts an item at the index specfied
+    # inserts an item at the index specified
     # @param [Integer] index
     # @param [Any] v
     # @raise [ArgumentError] if the index is protected by locking
@@ -170,8 +183,7 @@ module Axlsx
     end
 
     def to_xml_string(str = +'')
-      classname = @allowed_types[0].name.split('::').last
-      el_name = serialize_as.to_s || (classname[0, 1].downcase + classname[1..])
+      el_name = serialize_as.to_s
       str << '<' << el_name << ' count="' << size.to_s << '">'
       each { |item| item.to_xml_string(str) }
       str << '</' << el_name << '>'

data/lib/axlsx/util/storage.rb

@@ -85,16 +85,16 @@ module Axlsx
     # @return [Integer] sector
     attr_accessor :sector
 
-    # The 0 based index in the directoies chain for this the left sibling of this storage.
+    # The 0 based index in the directories chain for this the left sibling of this storage.
 
     # @return [Integer] left
     attr_accessor :left
 
-    # The 0 based index in the directoies chain for this the right sibling of this storage.
+    # The 0 based index in the directories chain for this the right sibling of this storage.
     # @return [Integer] right
     attr_accessor :right
 
-    # The 0 based index in the directoies chain for the child of this storage.
+    # The 0 based index in the directories chain for the child of this storage.
     # @return [Integer] child
     attr_accessor :child
 
@@ -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/util/uri_utils.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+
+module Axlsx
+  # This module defines some utils related to mime type detection
+  module UriUtils
+    class << self
+      # Performs an HTTP GeT request fetching only headers
+      def fetch_headers(uri, redirect_limit = 5)
+        redirect_count = 0
+        use_get = false
+
+        while redirect_count < redirect_limit
+          case (response = fetch_headers_request(uri, use_get: use_get))
+          when Net::HTTPSuccess
+            return response
+          when Net::HTTPMethodNotAllowed, Net::HTTPNotImplemented
+            fail_response(response) if use_get
+            use_get = true
+            next # Retry current URL with GET
+          when Net::HTTPRedirection
+            uri = follow_redirect(uri, response)
+            redirect_count += 1
+          else
+            fail_response(response)
+          end
+        end
+
+        raise ArgumentError, "Too many redirects (exceeded #{redirect_limit})"
+      end
+
+      private
+
+      def fetch_headers_request(uri, use_get: false)
+        Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+          path = build_path(uri)
+          if use_get
+            http.request_get(path) { |response| break(response) } # Exit early with just headers
+          else
+            http.head(path)
+          end
+        end
+      end
+
+      def build_path(uri)
+        "#{uri.path.empty? ? '/' : uri.path}#{"?#{uri.query}" if uri.query}"
+      end
+
+      def follow_redirect(original_uri, response)
+        location = response['location']
+
+        if location.nil? || location.empty?
+          raise ArgumentError, "Redirect response missing Location header"
+        end
+
+        if location.start_with?('http://', 'https://')
+          URI.parse(location)
+        else
+          URI.join(original_uri, location)
+        end
+      end
+
+      def fail_response(response)
+        raise ArgumentError, "Failed to fetch resource: #{response.code} #{response.message}"
+      end
+    end
+  end
+end

data/lib/axlsx/util/validators.rb

@@ -9,7 +9,7 @@ module Axlsx
     # @param [Any] v The value to be validated
     # @raise [ArgumentError] Raised if the value provided is not in the list of choices.
     # @return [Boolean] true if validation succeeds.
-    def self.validate(name, choices, v)
+    def self.validate(name, choices, v) # rubocop:disable Naming/PredicateMethod
       raise ArgumentError, format(ERR_RESTRICTION, v.to_s, name, choices.inspect) unless choices.include?(v)
 
       true
@@ -81,7 +81,7 @@ module Axlsx
     raise ArgumentError, format(ERR_ANGLE, v.inspect) unless v.to_i >= -5400000 && v.to_i <= 5400000
   end
 
-  # Validates an unsigned intger
+  # Validates an unsigned integer
   UINT_VALIDATOR = ->(arg) { arg.respond_to?(:>=) && arg >= 0 }
 
   # Requires that the value is a Integer and is greater or equal to 0
@@ -268,19 +268,19 @@ module Axlsx
     RestrictionValidator.validate :vertical_alignment, VALID_VERTICAL_ALIGNMENT_VALUES, v
   end
 
-  VALID_CONTENT_TYPE_VALUES = [TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT, STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT, JPEG_CT, GIF_CT, PNG_CT, DRAWING_CT, COMMENT_CT, VML_DRAWING_CT, PIVOT_TABLE_CT, PIVOT_TABLE_CACHE_DEFINITION_CT].freeze
+  VALID_CONTENT_TYPE_VALUES = [TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT, STYLES_CT, THEME_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT, JPEG_CT, GIF_CT, PNG_CT, DRAWING_CT, COMMENT_CT, VML_DRAWING_CT, PIVOT_TABLE_CT, PIVOT_TABLE_CACHE_DEFINITION_CT].freeze
 
   # Requires that the value is a valid content_type
-  # TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT, STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT, DRAWING_CT, COMMENT_CT are allowed
+  # TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT, STYLES_CT, THEME_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT, DRAWING_CT, COMMENT_CT are allowed
   # @param [Any] v The value validated
   def self.validate_content_type(v)
     RestrictionValidator.validate :content_type, VALID_CONTENT_TYPE_VALUES, v
   end
 
-  VALID_RELATIONSHIP_TYPE_VALUES = [XML_NS_R, TABLE_R, WORKBOOK_R, WORKSHEET_R, APP_R, RELS_R, CORE_R, STYLES_R, CHART_R, DRAWING_R, IMAGE_R, HYPERLINK_R, SHARED_STRINGS_R, COMMENT_R, VML_DRAWING_R, COMMENT_R_NULL, PIVOT_TABLE_R, PIVOT_TABLE_CACHE_DEFINITION_R].freeze
+  VALID_RELATIONSHIP_TYPE_VALUES = [XML_NS_R, TABLE_R, WORKBOOK_R, WORKSHEET_R, APP_R, RELS_R, CORE_R, STYLES_R, THEME_R, CHART_R, DRAWING_R, IMAGE_R, HYPERLINK_R, SHARED_STRINGS_R, COMMENT_R, VML_DRAWING_R, COMMENT_R_NULL, PIVOT_TABLE_R, PIVOT_TABLE_CACHE_DEFINITION_R].freeze
 
   # Requires that the value is a valid relationship_type
-  # XML_NS_R, TABLE_R, WORKBOOK_R, WORKSHEET_R, APP_R, RELS_R, CORE_R, STYLES_R, CHART_R, DRAWING_R, IMAGE_R, HYPERLINK_R, SHARED_STRINGS_R are allowed
+  # XML_NS_R, TABLE_R, WORKBOOK_R, WORKSHEET_R, APP_R, RELS_R, CORE_R, STYLES_R, THEME_R, CHART_R, DRAWING_R, IMAGE_R, HYPERLINK_R, SHARED_STRINGS_R are allowed
   # @param [Any] v The value validated
   def self.validate_relationship_type(v)
     RestrictionValidator.validate :relationship_type, VALID_RELATIONSHIP_TYPE_VALUES, v

data/lib/axlsx/version.rb

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

data/lib/axlsx/workbook/defined_name.rb

@@ -22,7 +22,7 @@
 # <xsd:attribute name="shortcutKey" type="s:ST_Xstring" use="optional"/>
 # <xsd:attribute name="publishToServer" type="xsd:boolean" use="optional" default="false"/>
 # <xsd:attribute name="workbookParameter" type="xsd:boolean" use="optional" default="false"/>
-# </xsd:extenstion>
+# </xsd:extension>
 # </xsd:simpleContent>
 
 module Axlsx
@@ -54,6 +54,7 @@ module Axlsx
     include Axlsx::SerializedAttributes
     include Axlsx::OptionsParser
     include Axlsx::Accessors
+
     # creates a new DefinedName.
     # @param [String] formula - the formula the defined name references
     # @param [Hash] options - A hash of key/value pairs that will be mapped to this instances attributes.

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

@@ -7,7 +7,7 @@ module Axlsx
   # As a developer, you should never need to directly work against this class. Simply set 'use_shared_strings'
   # on the package or workbook to generate a package that uses the shared strings table instead of inline strings.
   # @note Serialization performance is affected by using this serialization method so if you do not need interoperability
-  # it is recomended that you use the default inline string method of serialization.
+  # it is recommended that you use the default inline string method of serialization.
   class SharedStringsTable
     # The total number of strings in the workbook including duplicates
     # Empty cells are treated as blank strings
@@ -29,7 +29,7 @@ module Axlsx
     # @see Workbook#xml_space
     attr_reader :xml_space
 
-    # Creates a new Shared Strings Table agains an array of cells
+    # Creates a new Shared Strings Table against an array of cells
     # @param [Array] cells This is an array of all of the cells in the workbook
     # @param [Symbol] xml_space The xml:space behavior for the shared string table.
     def initialize(cells, xml_space = :preserve)
@@ -54,7 +54,7 @@ module Axlsx
 
     private
 
-    # Interate over all of the cells in the array.
+    # Iterate over all of the cells in the array.
     # if our unique cells array does not contain a sharable cell,
     # add the cell to our unique cells array and set the ssti attribute on the index of this cell in the shared strings table
     # if a sharable cell already exists in our unique_cells array, set the ssti attribute of the cell and move on.