caxlsx 4.2.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b15095b3a73b9f2e11f59bb674964ce206e11e699937e109831d9422fd26750f
-  data.tar.gz: e20e938a224f9da043fd4c7cfcd2c35af03a5bb037fc9164a59c44c110e3e248
+  metadata.gz: 97d26d1c2165080987473b430781c434b27f62510950ce0c27792058ab493bbf
+  data.tar.gz: 6d9f1f55b9b6602d86e2f6e30ce5e0589ac811bf49f8991f7dbc7f8fec42e6e3
 SHA512:
-  metadata.gz: 8cdd4b3843dd886f864212ecb4a40f528543d4fd1c682079c5497d3c40ea684bc64d214db4a974d3cea2071663bc3cfbd501543d6868077d9b369340c751bd90
-  data.tar.gz: 520da353dfbc0022ac6a3aae5006e669fd6f291aad95797b2ff24a2cf1634de4f66c52616efa2af5bfbd7524cf91393d56a6e6a433131f988402e277cacbaca5
+  metadata.gz: fd8f19deac0273ac8f59aca129190fc395b23077e34bfaafaa50dc48b9e6565430b94c7bbac8f19fd7272edacf0cac04438a2dc464b22670a575be75259cb2fe
+  data.tar.gz: 92ef32593a1ba1132b2b53ae08ecd82eb7e538edfdbb5e764fb325c57f6a2c66b56de6b67e04a48aa3dde5b663468a06d876292103f22fcf456b0da6563df967

data/CHANGELOG.md

@@ -2,6 +2,22 @@ CHANGELOG
 ---------
 - **Unreleased**
 
+- **September.01.25**: 4.4.0
+  - [PR #477](https://github.com/caxlsx/caxlsx/pull/477) Add package-level encryption and password protection.
+  - [PR #476](https://github.com/caxlsx/caxlsx/pull/476) Add Excel for Windows integration testing.
+  - [PR #476](https://github.com/caxlsx/caxlsx/pull/476) Add Excel for MacOS integration testing.
+  - [PR #469](https://github.com/caxlsx/caxlsx/pull/469) Add default theme file to Excel package.
+  - [PR #475](https://github.com/caxlsx/caxlsx/pull/475) Use timecop to fix transient time failure in tests
+  - [PR #474](https://github.com/caxlsx/caxlsx/pull/474) Add Windows and MacOS to the CI.
+  - [PR #474](https://github.com/caxlsx/caxlsx/pull/474) Fix local image file MIME type detection on Windows.
+  - [PR #474](https://github.com/caxlsx/caxlsx/pull/474) Load only HTTP headers when determining remote file MIME type.
+
+- **August.16.25**: 4.3.0
+  - [PR #421](https://github.com/caxlsx/caxlsx/pull/421) Add Rubyzip >= 2.4 support
+  - [PR #448](https://github.com/caxlsx/caxlsx/pull/448) Fix Bar Chart: set axis position for Apple Numbers compatibility
+  - [PR #466](https://github.com/caxlsx/caxlsx/pull/466) Use RubyGem's trusted publishing
+  - [PR #467](https://github.com/caxlsx/caxlsx/pull/467) Add JRuby 10.0 to the CI
+
 - **December.15.24**: 4.2.0
   - [PR #359](https://github.com/caxlsx/caxlsx/pull/359) Add `PivotTable#grand_totals` option to remove grand totals row/col
   - [PR #362](https://github.com/caxlsx/caxlsx/pull/362) Use widest width even if provided as fixed value

data/README.md

@@ -51,20 +51,21 @@ cell level input data validation.
 
 15. Support for page margins and print options
 
-16. Support for password and non password based sheet protection.
+16. Support for workbook-level encryption and password protection (requires [ooxml_crypt](https://github.com/teamsimplepay/ooxml_crypt) gem which only supports MRI Ruby.)
 
-17. First stage interoperability support for GoogleDocs, LibreOffice,
-and Numbers
+17. Support for sheet-level password and non-password protection.
 
-18. Support for defined names, which gives you repeated header rows for printing.
+18. First stage interoperability support for GoogleDocs, LibreOffice, and Numbers.
 
-19. Data labels for charts as well as series color customization.
+19. Support for defined names, which gives you repeated header rows for printing.
 
-20. Support for sheet headers and footers
+20. Data labels for charts as well as series color customization.
 
-21. Pivot Tables
+21. Support for sheet headers and footers
 
-22. Page Breaks
+22. Pivot Tables
+
+23. Page Breaks
 
 
 ## Install
@@ -107,6 +108,12 @@ Additional documentation is listed below:
 - [Style Reference](https://github.com/caxlsx/caxlsx/blob/master/docs/style_reference.md)
 - [Header and Footer Codes](https://github.com/caxlsx/caxlsx/blob/master/docs/header_and_footer_codes.md)
 
+You can run the documentation on your local by running the following:
+```sh
+gem install webrick
+yard server
+```
+
 ⚠ Please __do not create issues__ for questions regarding the usage of axlsx / caxlsx. Look through this README, the [examples folder](https://github.com/caxlsx/caxlsx/tree/master/examples), and the [FAQ](https://github.com/caxlsx/caxlsx/wiki/FAQ), and also check [questions tagged `axlsx` on Stack Overflow](https://stackoverflow.com/questions/tagged/axlsx).
 
 Feel free to add your question (including an answer!) to the FAQ if you think it is of general interest.
@@ -121,6 +128,8 @@ Currently the following additional gems are available:
   * Provides a `.axlsx` renderer to Rails so you can move all your spreadsheet code from your controller into view files.
 - [activeadmin-caxlsx](https://github.com/caxlsx/activeadmin-caxlsx)
   * An Active Admin plugin that includes DSL to create downloadable reports.
+- [ooxml_crypt](https://github.com/teamsimplepay/ooxml_crypt)
+  * Required to enable workbook encryption and password protection.
 
 ## Security
 

data/Rakefile

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
-require File.expand_path("#{File.dirname(__FILE__)}/lib/axlsx/version.rb")
-
-task build: :gendoc do
-  system "gem build axlsx.gemspec"
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
 task :benchmark do
   require File.expand_path("#{File.dirname(__FILE__)}/test/benchmark.rb")
@@ -23,8 +20,4 @@ Rake::TestTask.new do |t|
   t.warning = true
 end
 
-task release: :build do
-  system "gem push caxlsx-#{Axlsx::VERSION}.gem"
-end
-
 task default: :test

data/lib/axlsx/drawing/bar_3D_chart.rb

@@ -141,7 +141,17 @@ module Axlsx
     # category axes specified via axes[:val_axes] and axes[:cat_axis]
     # @return [Axes]
     def axes
-      @axes ||= Axes.new(cat_axis: CatAxis, val_axis: ValAxis)
+      @axes ||= begin
+        a = Axes.new(cat_axis: CatAxis, val_axis: ValAxis)
+
+        if bar_dir == :col
+          a[:val_axis].ax_pos = :l
+        else
+          a[:cat_axis].ax_pos = :l
+        end
+
+        a
+      end
     end
   end
 end

data/lib/axlsx/drawing/bar_chart.rb

@@ -131,7 +131,17 @@ module Axlsx
     # category axes specified via axes[:val_axes] and axes[:cat_axis]
     # @return [Axes]
     def axes
-      @axes ||= Axes.new(cat_axis: CatAxis, val_axis: ValAxis)
+      @axes ||= begin
+        a = Axes.new(cat_axis: CatAxis, val_axis: ValAxis)
+
+        if bar_dir == :col
+          a[:val_axis].ax_pos = :l
+        else
+          a[:cat_axis].ax_pos = :l
+        end
+
+        a
+      end
     end
   end
 end

data/lib/axlsx/drawing/chart.rb

@@ -6,6 +6,7 @@ module Axlsx
   # @see README for examples
   class Chart
     include Axlsx::OptionsParser
+
     # Creates a new chart object
     # @param [GraphicalFrame] frame The frame that holds this chart.
     # @option options [Cell, String] title

data/lib/axlsx/drawing/d_lbls.rb

@@ -9,6 +9,7 @@ module Axlsx
   class DLbls
     include Axlsx::Accessors
     include Axlsx::OptionsParser
+
     # creates a new DLbls object
     def initialize(chart_type, options = {})
       raise ArgumentError, 'chart_type must inherit from Chart' unless [Chart, LineChart].include?(chart_type.superclass)

data/lib/axlsx/drawing/vml_shape.rb

@@ -56,7 +56,7 @@ module Axlsx
            <x:AutoFill>False</x:AutoFill>
            <x:Row>#{row}</x:Row>
            <x:Column>#{column}</x:Column>
-           #{@visible ? '<x:Visible/>' : ''}
+           #{'<x:Visible/>' if @visible}
           </x:ClientData>
          </v:shape>
       XML

data/lib/axlsx/package.rb

@@ -82,6 +82,8 @@ module Axlsx
     # @option options [String] :zip_command When `nil`, `#serialize` with RubyZip to
     #   zip the XLSX file contents. When a String, the provided zip command (e.g.,
     #   "zip") is used to zip the file contents (may be faster for large files)
+    # @option options [String] :password When specified, the serialized packaged will be
+    #   encrypted with the password. Requires ooxml_crypt gem.
     # @return [Boolean] False if confirm_valid and validation errors exist. True if the package was serialized
     # @note A tremendous amount of effort has gone into ensuring that you cannot create invalid xlsx documents.
     #   options[:confirm_valid] should be used in the rare case that you cannot open the serialized file.
@@ -108,7 +110,7 @@ module Axlsx
         workbook.apply_styles
       end
 
-      confirm_valid, zip_command = parse_serialize_options(options, secondary_options)
+      confirm_valid, zip_command, password = parse_serialize_options(options, secondary_options)
       return false unless !confirm_valid || validate.empty?
 
       zip_provider = if zip_command
@@ -120,15 +122,31 @@ module Axlsx
       zip_provider.open(output) do |zip|
         write_parts(zip)
       end
+
+      if password && !password.empty?
+        require_ooxml_crypt!
+        OoxmlCrypt.encrypt_file(output, password, output)
+      end
+
       true
     ensure
       Relationship.clear_ids_cache
     end
 
     # Serialize your workbook to a StringIO instance
-    # @param [Boolean] confirm_valid Validate the package prior to serialization.
-    # @return [StringIO|Boolean] False if confirm_valid and validation errors exist. rewound string IO if not.
-    def to_stream(confirm_valid = false)
+    # @param [Boolean] old_confirm_valid (Deprecated) Validate the package prior to serialization.
+    #   Use :confirm_valid keyword arg instead.
+    # @option kwargs [Boolean] :confirm_valid Validate the package prior to serialization.
+    # @option kwargs [String] :password When specified, the serialized packaged will be
+    #   encrypted with the password. Requires ooxml_crypt gem.
+    # @return [StringIO|Boolean] False if confirm_valid and validation errors exist. Rewound string IO if not.
+    def to_stream(old_confirm_valid = nil, confirm_valid: false, password: nil)
+      unless old_confirm_valid.nil?
+        warn "[DEPRECATION] Axlsx::Package#to_stream with confirm_valid as a non-keyword arg is deprecated. " \
+             "Use keyword arg instead e.g., package.to_stream(confirm_valid: false)"
+        confirm_valid ||= old_confirm_valid
+      end
+
       unless workbook.styles_applied
         workbook.apply_styles
       end
@@ -140,6 +158,12 @@ module Axlsx
         write_parts(zip)
       end
       stream.rewind
+
+      if password && !password.empty?
+        require_ooxml_crypt!
+        stream = StringIO.new(OoxmlCrypt.encrypt(stream.read, password))
+      end
+
       stream
     ensure
       Relationship.clear_ids_cache
@@ -147,7 +171,7 @@ module Axlsx
 
     # Encrypt the package into a CFB using the password provided
     # This is not ready yet
-    def encrypt(file_name, password)
+    def encrypt(file_name, password) # rubocop:disable Naming/PredicateMethod
       false
       # moc = MsOffCrypto.new(file_name, password)
       # moc.save
@@ -211,7 +235,8 @@ module Axlsx
     # @return [Zip::Entry]
     def zip_entry_for_part(part)
       timestamp = Zip::DOSTime.at(@core.created.to_i)
-      Zip::Entry.new("", part[:entry], "", "", 0, 0, Zip::Entry::DEFLATED, 0, timestamp)
+
+      Zip::Entry.new("", part[:entry], time: timestamp)
     end
 
     # The parts of a package
@@ -220,6 +245,7 @@ module Axlsx
     def parts
       parts = [
         { entry: "xl/#{STYLES_PN}", doc: workbook.styles, schema: SML_XSD },
+        { entry: "xl/#{THEME_PN}", doc: workbook.theme, schema: THEME_XSD },
         { entry: CORE_PN, doc: @core, schema: CORE_XSD },
         { entry: APP_PN, doc: @app, schema: APP_XSD },
         { entry: WORKBOOK_RELS_PN, doc: workbook.relationships, schema: RELS_XSD },
@@ -356,6 +382,7 @@ module Axlsx
       c_types << Override.new(PartName: "/#{APP_PN}", ContentType: APP_CT)
       c_types << Override.new(PartName: "/#{CORE_PN}", ContentType: CORE_CT)
       c_types << Override.new(PartName: "/xl/#{STYLES_PN}", ContentType: STYLES_CT)
+      c_types << Override.new(PartName: "/xl/#{THEME_PN}", ContentType: THEME_CT)
       c_types << Axlsx::Override.new(PartName: "/#{WORKBOOK_PN}", ContentType: WORKBOOK_CT)
       c_types.lock
       c_types
@@ -374,8 +401,8 @@ module Axlsx
     end
 
     # Parse the arguments of `#serialize`
-    # @return [Boolean, (String or nil)] Returns an array where the first value is
-    #   `confirm_valid` and the second is the `zip_command`.
+    # @return [Boolean, (String or nil), (String or nil)] Returns a 3-tuple where values are
+    #   `confirm_valid`, `zip_command`, and `password`.
     # @private
     def parse_serialize_options(options, secondary_options)
       if secondary_options
@@ -384,17 +411,23 @@ module Axlsx
       end
       if options.is_a?(Hash)
         options.merge!(secondary_options || {})
-        invalid_keys = options.keys - [:confirm_valid, :zip_command]
+        invalid_keys = options.keys - [:confirm_valid, :zip_command, :password]
         if invalid_keys.any?
           raise ArgumentError, "Invalid keyword arguments: #{invalid_keys}"
         end
 
-        [options.fetch(:confirm_valid, false), options.fetch(:zip_command, nil)]
+        [options.fetch(:confirm_valid, false), options.fetch(:zip_command, nil), options.fetch(:password, nil)]
       else
         warn "[DEPRECATION] Axlsx::Package#serialize with confirm_valid as a boolean is deprecated. " \
              "Use keyword args instead e.g., package.serialize(output, confirm_valid: false)"
         parse_serialize_options((secondary_options || {}).merge(confirm_valid: options), nil)
       end
     end
+
+    def require_ooxml_crypt!
+      return if defined?(OoxmlCrypt)
+
+      raise 'Axlsx encryption requires ooxml_crypt gem'
+    end
   end
 end

data/lib/axlsx/stylesheet/border_pr.rb

@@ -4,6 +4,7 @@ module Axlsx
   # A border part.
   class BorderPr
     include Axlsx::OptionsParser
+
     # @return [Color] The color of this border part.
     attr_reader :color
 

data/lib/axlsx/stylesheet/pattern_fill.rb

@@ -6,6 +6,7 @@ module Axlsx
   # @see Style#add_style
   class PatternFill
     include Axlsx::OptionsParser
+
     # Creates a new PatternFill Object
     # @option options [Symbol] patternType
     # @option options [Color] fgColor

data/lib/axlsx/stylesheet/styles.rb

@@ -15,6 +15,7 @@ module Axlsx
   require_relative 'table_style'
   require_relative 'table_styles'
   require_relative 'table_style_element'
+  require_relative 'theme'
   require_relative 'dxf'
   require_relative 'xf'
   require_relative 'cell_protection'

data/lib/axlsx/stylesheet/theme.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module Axlsx
+  # Theme represents the theme part of the package and is responsible for
+  # generating the default Office theme that is required for encryption compatibility
+  class Theme
+    # The part name of this theme
+    # @return [String]
+    def pn
+      THEME_PN
+    end
+
+    # Serializes the default theme to XML
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = +'')
+      str << <<~XML.delete("\n")
+        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+        <a:theme xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main" name="Office Theme">
+        <a:themeElements>
+        <a:clrScheme name="Office">
+        <a:dk1><a:sysClr val="windowText" lastClr="000000"/></a:dk1>
+        <a:lt1><a:sysClr val="window" lastClr="FFFFFF"/></a:lt1>
+        <a:dk2><a:srgbClr val="1F497D"/></a:dk2>
+        <a:lt2><a:srgbClr val="EEECE1"/></a:lt2>
+        <a:accent1><a:srgbClr val="4F81BD"/></a:accent1>
+        <a:accent2><a:srgbClr val="C0504D"/></a:accent2>
+        <a:accent3><a:srgbClr val="9BBB59"/></a:accent3>
+        <a:accent4><a:srgbClr val="8064A2"/></a:accent4>
+        <a:accent5><a:srgbClr val="4BACC6"/></a:accent5>
+        <a:accent6><a:srgbClr val="F79646"/></a:accent6>
+        <a:hlink><a:srgbClr val="0000FF"/></a:hlink>
+        <a:folHlink><a:srgbClr val="800080"/></a:folHlink>
+        </a:clrScheme>
+
+        <a:fontScheme name="Office">
+        <a:majorFont>
+        <a:latin typeface="Cambria"/>
+        <a:ea typeface=""/>
+        <a:cs typeface=""/>
+        </a:majorFont>
+        <a:minorFont>
+        <a:latin typeface="Calibri"/>
+        <a:ea typeface=""/>
+        <a:cs typeface=""/>
+        </a:minorFont>
+        </a:fontScheme>
+
+        <a:fmtScheme name="Office">
+        <a:fillStyleLst>
+        <a:solidFill><a:schemeClr val="phClr"/></a:solidFill>
+        <a:gradFill rotWithShape="1">
+        <a:gsLst>
+        <a:gs pos="0"><a:schemeClr val="phClr"><a:tint val="50000"/><a:satMod val="300000"/></a:schemeClr></a:gs>
+        <a:gs pos="35000"><a:schemeClr val="phClr"><a:tint val="37000"/><a:satMod val="300000"/></a:schemeClr></a:gs>
+        <a:gs pos="100000"><a:schemeClr val="phClr"><a:tint val="15000"/><a:satMod val="350000"/></a:schemeClr></a:gs>
+        </a:gsLst>
+        <a:lin ang="16200000" scaled="1"/>
+        </a:gradFill>
+        <a:gradFill rotWithShape="1">
+        <a:gsLst>
+        <a:gs pos="0"><a:schemeClr val="phClr"><a:tint val="100000"/><a:shade val="100000"/><a:satMod val="130000"/></a:schemeClr></a:gs>
+        <a:gs pos="100000"><a:schemeClr val="phClr"><a:tint val="50000"/><a:shade val="100000"/><a:satMod val="350000"/></a:schemeClr></a:gs>
+        </a:gsLst>
+        <a:lin ang="16200000" scaled="false"/>
+        </a:gradFill>
+        </a:fillStyleLst>
+
+        <a:lnStyleLst>
+        <a:ln w="9525" cap="flat" cmpd="sng" algn="ctr">
+        <a:solidFill><a:schemeClr val="phClr"><a:shade val="95000"/><a:satMod val="105000"/></a:schemeClr></a:solidFill>
+        <a:prstDash val="solid"/>
+        </a:ln>
+        <a:ln w="25400" cap="flat" cmpd="sng" algn="ctr">
+        <a:solidFill><a:schemeClr val="phClr"/></a:solidFill>
+        <a:prstDash val="solid"/>
+        </a:ln>
+        <a:ln w="38100" cap="flat" cmpd="sng" algn="ctr">
+        <a:solidFill><a:schemeClr val="phClr"/></a:solidFill>
+        <a:prstDash val="solid"/>
+        </a:ln>
+        </a:lnStyleLst>
+
+        <a:effectStyleLst>
+        <a:effectStyle>
+        <a:effectLst>
+        <a:outerShdw blurRad="40000" dist="20000" dir="5400000" rotWithShape="false">
+        <a:srgbClr val="000000"><a:alpha val="38000"/></a:srgbClr>
+        </a:outerShdw>
+        </a:effectLst>
+        </a:effectStyle>
+        <a:effectStyle>
+        <a:effectLst>
+        <a:outerShdw blurRad="40000" dist="23000" dir="5400000" rotWithShape="false">
+        <a:srgbClr val="000000"><a:alpha val="35000"/></a:srgbClr>
+        </a:outerShdw>
+        </a:effectLst>
+        </a:effectStyle>
+        <a:effectStyle>
+        <a:effectLst>
+        <a:outerShdw blurRad="40000" dist="23000" dir="5400000" rotWithShape="false">
+        <a:srgbClr val="000000"><a:alpha val="35000"/></a:srgbClr>
+        </a:outerShdw>
+        </a:effectLst>
+        <a:scene3d>
+        <a:camera prst="orthographicFront"><a:rot lat="0" lon="0" rev="0"/></a:camera>
+        <a:lightRig rig="threePt" dir="t"><a:rot lat="0" lon="0" rev="1200000"/></a:lightRig>
+        </a:scene3d>
+        <a:sp3d><a:bevelT w="63500" h="25400"/></a:sp3d>
+        </a:effectStyle>
+        </a:effectStyleLst>
+
+        <a:bgFillStyleLst>
+        <a:solidFill><a:schemeClr val="phClr"/></a:solidFill>
+        <a:gradFill rotWithShape="1">
+        <a:gsLst>
+        <a:gs pos="0"><a:schemeClr val="phClr"><a:tint val="40000"/><a:satMod val="350000"/></a:schemeClr></a:gs>
+        <a:gs pos="40000"><a:schemeClr val="phClr"><a:tint val="45000"/><a:shade val="99000"/><a:satMod val="350000"/></a:schemeClr></a:gs>
+        <a:gs pos="100000"><a:schemeClr val="phClr"><a:shade val="20000"/><a:satMod val="255000"/></a:schemeClr></a:gs>
+        </a:gsLst>
+        <a:path path="circle"><a:fillToRect l="50000" t="-80000" r="50000" b="180000"/></a:path>
+        </a:gradFill>
+        <a:gradFill rotWithShape="1">
+        <a:gsLst>
+        <a:gs pos="0"><a:schemeClr val="phClr"><a:tint val="80000"/><a:satMod val="300000"/></a:schemeClr></a:gs>
+        <a:gs pos="100000"><a:schemeClr val="phClr"><a:shade val="30000"/><a:satMod val="200000"/></a:schemeClr></a:gs>
+        </a:gsLst>
+        <a:path path="circle"><a:fillToRect l="50000" t="50000" r="50000" b="50000"/></a:path>
+        </a:gradFill>
+        </a:bgFillStyleLst>
+        </a:fmtScheme>
+        </a:themeElements>
+
+        <a:objectDefaults>
+        <a:spDef>
+        <a:spPr/>
+        <a:bodyPr/>
+        <a:lstStyle/>
+        <a:style>
+        <a:lnRef idx="1"><a:schemeClr val="accent1"/></a:lnRef>
+        <a:fillRef idx="3"><a:schemeClr val="accent1"/></a:fillRef>
+        <a:effectRef idx="2"><a:schemeClr val="accent1"/></a:effectRef>
+        <a:fontRef idx="minor"><a:schemeClr val="lt1"/></a:fontRef>
+        </a:style>
+        </a:spDef>
+        <a:lnDef>
+        <a:spPr/>
+        <a:bodyPr/>
+        <a:lstStyle/>
+        <a:style>
+        <a:lnRef idx="2"><a:schemeClr val="accent1"/></a:lnRef>
+        <a:fillRef idx="0"><a:schemeClr val="accent1"/></a:fillRef>
+        <a:effectRef idx="1"><a:schemeClr val="accent1"/></a:effectRef>
+        <a:fontRef idx="minor"><a:schemeClr val="tx1"/></a:fontRef>
+        </a:style>
+        </a:lnDef>
+        </a:objectDefaults>
+        <a:extraClrSchemeLst/>
+        </a:theme>
+      XML
+    end
+  end
+end

data/lib/axlsx/stylesheet/xf.rb

@@ -8,6 +8,7 @@ module Axlsx
 
     include Axlsx::SerializedAttributes
     include Axlsx::OptionsParser
+
     # Creates a new Xf object
     # @option options [Integer] numFmtId
     # @option options [Integer] fontId

data/lib/axlsx/util/buffered_zip_output_stream.rb

@@ -19,7 +19,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) do |zos|
         bzos = new(zos)
         yield(bzos)
       ensure
@@ -28,7 +28,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) 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,6 +268,9 @@ module Axlsx
   # drawing validation schema
   DRAWING_XSD = "#{SCHEMA_BASE}dml-spreadsheetDrawing.xsd"
 
+  # 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
 

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

@@ -183,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/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
@@ -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.2.0"
+  VERSION = "4.4.0"
 end

data/lib/axlsx/workbook/defined_name.rb

@@ -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/workbook.rb

@@ -184,6 +184,12 @@ module Axlsx
       @styles
     end
 
+    # The theme associated with this workbook
+    # @return [Theme]
+    def theme
+      @theme ||= Theme.new
+    end
+
     # An array that holds all cells with styles
     # @return Set
     def styled_cells
@@ -373,6 +379,7 @@ module Axlsx
         r << Relationship.new(pivot_table.cache_definition, PIVOT_TABLE_CACHE_DEFINITION_R, format(PIVOT_TABLE_CACHE_DEFINITION_PN, index + 1))
       end
       r << Relationship.new(self, STYLES_R, STYLES_PN)
+      r << Relationship.new(self, THEME_R, THEME_PN)
       if use_shared_strings
         r << Relationship.new(self, SHARED_STRINGS_R, SHARED_STRINGS_PN)
       end

data/lib/axlsx/workbook/workbook_view.rb

@@ -38,7 +38,7 @@ module Axlsx
     # @option [Boolean] show_horizontal_scroll Specifies a boolean value that indicates whether to display the horizontal scroll bar in the user interface.
     # @option [Boolean] show_vertical_scroll Specifies a boolean value that indicates whether to display the vertical scroll bar.
     # @option [Boolean] show_sheet_tabs Specifies a boolean value that indicates whether to display the sheet tabs in the user interface.
-    # @option [Integer] tab_ratio Specifies ratio between the workbook tabs bar and the horizontal scroll bar.
+    # @option [Integer] tab_ratio Specifies the ratio between the workbook tabs bar and the horizontal scroll bar (from 0 to 1000, higher values mean more space for tabs). May only be supported on some clients.
     # @option [Integer] first_sheet Specifies the index to the first sheet in this book view.
     # @option [Integer] active_tab Specifies an unsignedInt that contains the index to the active sheet in this book view.
     # @option [Integer] x_window Specifies the X coordinate for the upper left corner of the workbook window. The unit of measurement for this value is twips.

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

@@ -41,7 +41,7 @@ module Axlsx
     # date_group_items restrictions.
     # @param [Cell] cell The cell to test against items
     # TODO implement this for date filters as well!
-    def apply(cell)
+    def apply(cell) # rubocop:disable Naming/PredicateMethod
       return false unless cell
 
       filter_items.each do |filter|

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

@@ -166,7 +166,7 @@ module Axlsx
 
     # Indicates that the cell has one or more of the custom cell styles applied.
     # @return [Boolean]
-    def is_text_run? # rubocop:disable Naming/PredicateName
+    def is_text_run? # rubocop:disable Naming/PredicatePrefix
       defined?(@is_text_run) && @is_text_run && !contains_rich_text?
     end
 
@@ -410,13 +410,13 @@ module Axlsx
       CellSerializer.to_xml_string r_index, c_index, self, str
     end
 
-    def is_formula? # rubocop:disable Naming/PredicateName
+    def is_formula? # rubocop:disable Naming/PredicatePrefix
       return false if escape_formulas
 
       type == :string && @value.to_s.start_with?(FORMULA_PREFIX)
     end
 
-    def is_array_formula? # rubocop:disable Naming/PredicateName
+    def is_array_formula? # rubocop:disable Naming/PredicatePrefix
       return false if escape_formulas
 
       type == :string &&

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

@@ -9,6 +9,7 @@ module Axlsx
 
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
+
     # Create a new Col objects
     # @param min First column affected by this 'column info' record.
     # @param max Last column affected by this 'column info' record.

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

@@ -343,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/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/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

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

@@ -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

data/lib/axlsx.rb

@@ -13,6 +13,7 @@ require 'cgi'
 require 'set'
 require 'time'
 require 'uri'
+require 'net/http'
 
 require_relative 'axlsx/util/simple_typed_list'
 require_relative 'axlsx/util/constants'
@@ -20,6 +21,7 @@ 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'

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caxlsx
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Randy Morgan
 - Jurriaan Pruis
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-15 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)
@@ -177,6 +176,7 @@ files:
 - lib/axlsx/stylesheet/table_style.rb
 - lib/axlsx/stylesheet/table_style_element.rb
 - lib/axlsx/stylesheet/table_styles.rb
+- lib/axlsx/stylesheet/theme.rb
 - lib/axlsx/stylesheet/xf.rb
 - lib/axlsx/util/accessors.rb
 - lib/axlsx/util/buffered_zip_output_stream.rb
@@ -186,6 +186,7 @@ files:
 - lib/axlsx/util/serialized_attributes.rb
 - lib/axlsx/util/simple_typed_list.rb
 - lib/axlsx/util/storage.rb
+- lib/axlsx/util/uri_utils.rb
 - lib/axlsx/util/validators.rb
 - lib/axlsx/util/zip_command.rb
 - lib/axlsx/version.rb
@@ -297,7 +298,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 +312,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Excel OOXML (xlsx) with charts, styles, images and autowidth columns.
 test_files: []