write_xlsx 1.11.1 → 1.12.0

data/lib/write_xlsx/worksheet.rb

@@ -113,7 +113,8 @@ module Writexlsx
       @drawing_rels_id        = 0
       @vml_drawing_rels       = {}
       @vml_drawing_rels_id    = 0
-      @has_dynamic_arrays     = false
+      @has_dynamic_functions  = false
+      @has_embedded_images    = false
 
       @use_future_functions  = false
 
@@ -160,6 +161,8 @@ module Writexlsx
         @page_setup.margin_footer = 0.5
         @page_setup.header_footer_aligns = false
       end
+
+      @embedded_image_indexes = @workbook.embedded_image_indexes
     end
 
     def set_xml_writer(filename) # :nodoc:
@@ -228,15 +231,26 @@ module Writexlsx
     #
     # Hide this worksheet.
     #
-    def hide
-      @hidden = true
+    def hide(hidden = :hidden)
+      @hidden = hidden
       @selected = false
       @workbook.activesheet = 0 if @workbook.activesheet == @index
       @workbook.firstsheet  = 0 if @workbook.firstsheet  == @index
     end
 
+    #
+    # Hide this worksheet. This can only be unhidden from VBA.
+    #
+    def very_hidden
+      hide(:very_hidden)
+    end
+
     def hidden? # :nodoc:
-      @hidden
+      @hidden == :hidden
+    end
+
+    def very_hidden? # :nodoc:
+      @hidden == :very_hidden
     end
 
     #
@@ -271,7 +285,7 @@ module Writexlsx
       if range.nil?
         raise "The range must be defined in unprotect_range())\n"
       else
-        range = range.gsub(/\$/, "")
+        range = range.gsub("$", "")
         range = range.sub(/^=/, "")
         @num_protected_ranges += 1
       end
@@ -612,8 +626,17 @@ module Writexlsx
     #
     # This method is used to display the worksheet in "Page View/Layout" mode.
     #
-    def set_page_view(flag = true)
-      @page_view = !!flag
+    def set_page_view(flag = 1)
+      @page_view = flag
+    end
+
+    #
+    # set_pagebreak_view
+    #
+    # Set the page view mode.
+    #
+    def set_pagebreak_view
+      @page_view = 2
     end
 
     #
@@ -648,7 +671,7 @@ module Writexlsx
       raise 'Header string must be less than 255 characters' if string.length > 255
 
       # Replace the Excel placeholder &[Picture] with the internal &G.
-      @page_setup.header = string.gsub(/&\[Picture\]/, '&G')
+      @page_setup.header = string.gsub("&[Picture]", '&G')
 
       @page_setup.header_footer_aligns = options[:align_with_margins] if options[:align_with_margins]
 
@@ -664,7 +687,7 @@ module Writexlsx
       end
 
       # placeholeder /&G/ の数
-      placeholder_count = @page_setup.header.scan(/&G/).count
+      placeholder_count = @page_setup.header.scan("&G").count
 
       image_count = @header_images.count
 
@@ -685,7 +708,7 @@ module Writexlsx
       @page_setup.footer = string.dup
 
       # Replace the Excel placeholder &[Picture] with the internal &G.
-      @page_setup.footer = string.gsub(/&\[Picture\]/, '&G')
+      @page_setup.footer = string.gsub("&[Picture]", '&G')
 
       @page_setup.header_footer_aligns = options[:align_with_margins] if options[:align_with_margins]
 
@@ -701,7 +724,7 @@ module Writexlsx
       end
 
       # placeholeder /&G/ の数
-      placeholder_count = @page_setup.footer.scan(/&G/).count
+      placeholder_count = @page_setup.footer.scan("&G").count
 
       image_count = @footer_images.count
 
@@ -1320,7 +1343,7 @@ module Writexlsx
     # Utility method to strip equal sign and array braces from a formula
     # and also expand out future and dynamic array formulas.
     #
-    def prepare_formula(given_formula)
+    def prepare_formula(given_formula, expand_future_functions = nil)
       # Ignore empty/null formulas.
       return given_formula unless ptrue?(given_formula)
 
@@ -1331,26 +1354,46 @@ module Writexlsx
       return formula if formula =~ /_xlfn\./
 
       # Expand dynamic array formulas.
-      formula = expand_formula(formula, 'LET\(')
+      formula = expand_formula(formula, 'ANCHORARRAY\(')
+      formula = expand_formula(formula, 'BYCOL\(')
+      formula = expand_formula(formula, 'BYROW\(')
+      formula = expand_formula(formula, 'CHOOSECOLS\(')
+      formula = expand_formula(formula, 'CHOOSEROWS\(')
+      formula = expand_formula(formula, 'DROP\(')
+      formula = expand_formula(formula, 'EXPAND\(')
+      formula = expand_formula(formula, 'FILTER\(', '._xlws')
+      formula = expand_formula(formula, 'HSTACK\(')
       formula = expand_formula(formula, 'LAMBDA\(')
+      formula = expand_formula(formula, 'MAKEARRAY\(')
+      formula = expand_formula(formula, 'MAP\(')
+      formula = expand_formula(formula, 'RANDARRAY\(')
+      formula = expand_formula(formula, 'REDUCE\(')
+      formula = expand_formula(formula, 'SCAN\(')
+      formula = expand_formula(formula, 'SEQUENCE\(')
       formula = expand_formula(formula, 'SINGLE\(')
+      formula = expand_formula(formula, 'SORT\(', '._xlws')
       formula = expand_formula(formula, 'SORTBY\(')
+      formula = expand_formula(formula, 'SWITCH\(')
+      formula = expand_formula(formula, 'TAKE\(')
+      formula = expand_formula(formula, 'TEXTSPLIT\(')
+      formula = expand_formula(formula, 'TOCOL\(')
+      formula = expand_formula(formula, 'TOROW\(')
       formula = expand_formula(formula, 'UNIQUE\(')
-      formula = expand_formula(formula, 'XMATCH\(')
+      formula = expand_formula(formula, 'VSTACK\(')
+      formula = expand_formula(formula, 'WRAPCOLS\(')
+      formula = expand_formula(formula, 'WRAPROWS\(')
       formula = expand_formula(formula, 'XLOOKUP\(')
-      formula = expand_formula(formula, 'SEQUENCE\(')
-      formula = expand_formula(formula, 'RANDARRAY\(')
-      formula = expand_formula(formula, 'SORT\(', '._xlws')
-      formula = expand_formula(formula, 'ANCHORARRAY\(')
-      formula = expand_formula(formula, 'FILTER\(', '._xlws')
 
-      return formula unless @use_future_functions
+      if !@use_future_functions && !ptrue?(expand_future_functions)
+        return formula
+      end
 
       # Future functions.
       formula = expand_formula(formula, 'ACOTH\(')
       formula = expand_formula(formula, 'ACOT\(')
       formula = expand_formula(formula, 'AGGREGATE\(')
       formula = expand_formula(formula, 'ARABIC\(')
+      formula = expand_formula(formula, 'ARRAYTOTEXT\(')
       formula = expand_formula(formula, 'BASE\(')
       formula = expand_formula(formula, 'BETA.DIST\(')
       formula = expand_formula(formula, 'BETA.INV\(')
@@ -1406,6 +1449,7 @@ module Writexlsx
       formula = expand_formula(formula, 'HYPGEOM.DIST\(')
       formula = expand_formula(formula, 'IFNA\(')
       formula = expand_formula(formula, 'IFS\(')
+      formula = expand_formula(formula, 'IMAGE\(')
       formula = expand_formula(formula, 'IMCOSH\(')
       formula = expand_formula(formula, 'IMCOT\(')
       formula = expand_formula(formula, 'IMCSCH\(')
@@ -1415,7 +1459,9 @@ module Writexlsx
       formula = expand_formula(formula, 'IMSINH\(')
       formula = expand_formula(formula, 'IMTAN\(')
       formula = expand_formula(formula, 'ISFORMULA\(')
+      formula = expand_formula(formula, 'ISOMITTED\(')
       formula = expand_formula(formula, 'ISOWEEKNUM\(')
+      formula = expand_formula(formula, 'LET\(')
       formula = expand_formula(formula, 'LOGNORM.DIST\(')
       formula = expand_formula(formula, 'LOGNORM.INV\(')
       formula = expand_formula(formula, 'MAXIFS\(')
@@ -1450,24 +1496,26 @@ module Writexlsx
       formula = expand_formula(formula, 'SKEW.P\(')
       formula = expand_formula(formula, 'STDEV.P\(')
       formula = expand_formula(formula, 'STDEV.S\(')
-      formula = expand_formula(formula, 'SWITCH\(')
       formula = expand_formula(formula, 'T.DIST.2T\(')
       formula = expand_formula(formula, 'T.DIST.RT\(')
       formula = expand_formula(formula, 'T.DIST\(')
       formula = expand_formula(formula, 'T.INV.2T\(')
       formula = expand_formula(formula, 'T.INV\(')
       formula = expand_formula(formula, 'T.TEST\(')
+      formula = expand_formula(formula, 'TEXTAFTER\(')
+      formula = expand_formula(formula, 'TEXTBEFORE\(')
       formula = expand_formula(formula, 'TEXTJOIN\(')
       formula = expand_formula(formula, 'UNICHAR\(')
       formula = expand_formula(formula, 'UNICODE\(')
+      formula = expand_formula(formula, 'VALUETOTEXT\(')
       formula = expand_formula(formula, 'VAR.P\(')
       formula = expand_formula(formula, 'VAR.S\(')
       formula = expand_formula(formula, 'WEBSERVICE\(')
       formula = expand_formula(formula, 'WEIBULL.DIST\(')
+      formula = expand_formula(formula, 'XMATCH\(')
       formula = expand_formula(formula, 'XOR\(')
       expand_formula(formula, 'Z.TEST\(')
     end
-    private :prepare_formula
 
     #
     # :call-seq:
@@ -1492,7 +1540,7 @@ module Writexlsx
       raise WriteXLSXInsufficientArgumentError if [_row, _col, _formula].include?(nil)
 
       # Check for dynamic array functions.
-      regex = /\bLET\(|\bSORT\(|\bLAMBDA\(|\bSINGLE\(|\bSORTBY\(|\bUNIQUE\(|\bXMATCH\(|\bFILTER\(|\bXLOOKUP\(|\bSEQUENCE\(|\bRANDARRAY\(|\bANCHORARRAY\(/
+      regex = /\bANCHORARRAY\(|\bBYCOL\(|\bBYROW\(|\bCHOOSECOLS\(|\bCHOOSEROWS\(|\bDROP\(|\bEXPAND\(|\bFILTER\(|\bHSTACK\(|\bLAMBDA\(|\bMAKEARRAY\(|\bMAP\(|\bRANDARRAY\(|\bREDUCE\(|\bSCAN\(|\bSEQUENCE\(|\bSINGLE\(|\bSORT\(|\bSORTBY\(|\bSWITCH\(|\bTAKE\(|\bTEXTSPLIT\(|\bTOCOL\(|\bTOROW\(|\bUNIQUE\(|\bVSTACK\(|\bWRAPCOLS\(|\bWRAPROWS\(|\bXLOOKUP\(/
       if _formula =~ regex
         return write_dynamic_array_formula(
           _row, _col, _row, _col, _formula, _format, _value
@@ -1505,7 +1553,7 @@ module Writexlsx
       else
         check_dimensions(_row, _col)
         store_row_col_max_min_values(_row, _col)
-        _formula = _formula.sub(/^=/, '')
+        _formula = prepare_formula(_formula)
 
         store_data_to_table(FormulaCellData.new(_formula, _format, _value), _row, _col)
       end
@@ -1551,7 +1599,7 @@ module Writexlsx
               end
 
       # Modify the formula string, as needed.
-      formula = prepare_formula(formula)
+      formula = prepare_formula(formula, 1)
 
       store_data_to_table(
         if type == 'a'
@@ -1590,7 +1638,7 @@ module Writexlsx
     #
     def write_dynamic_array_formula(row1, col1, row2 = nil, col2 = nil, formula = nil, format = nil, value = nil)
       write_array_formula_base('d', row1, col1, row2, col2, formula, format, value)
-      @has_dynamic_arrays = true
+      @has_dynamic_functions = true
     end
 
     #
@@ -1738,21 +1786,23 @@ module Writexlsx
     # The label is written using the {#write()}[#method-i-write] method. Therefore it is
     # possible to write strings, numbers or formulas as labels.
     #
-    def write_url(row, col, url = nil, format = nil, str = nil, tip = nil)
+    def write_url(row, col, url = nil, format = nil, str = nil, tip = nil, ignore_write_string = false)
       # Check for a cell reference in A1 notation and substitute row and column
       if (row_col_array = row_col_notation(row))
-        _row, _col = row_col_array
-        _url       = col
-        _format    = url
-        _str       = format
-        _tip       = str
+        _row, _col           = row_col_array
+        _url                 = col
+        _format              = url
+        _str                 = format
+        _tip                 = str
+        _ignore_write_string = tip
       else
-        _row = row
-        _col = col
-        _url = url
-        _format = format
-        _str = str
-        _tip = tip
+        _row                 = row
+        _col                 = col
+        _url                 = url
+        _format              = format
+        _str                 = str
+        _tip                 = tip
+        _ignore_write_string = ignore_write_string
       end
       _format, _str = _str, _format if _str.respond_to?(:xf_index) || !_format.respond_to?(:xf_index)
       raise WriteXLSXInsufficientArgumentError if [_row, _col, _url].include?(nil)
@@ -1770,7 +1820,7 @@ module Writexlsx
       _format ||= @default_url_format
 
       # Write the hyperlink string.
-      write_string(_row, _col, hyperlink.str, _format)
+      write_string(_row, _col, hyperlink.str, _format) unless _ignore_write_string
     end
 
     #
@@ -1915,6 +1965,65 @@ module Writexlsx
       ]
     end
 
+    #
+    # Embed an image into the worksheet.
+    #
+    def embed_image(row, col, filename, options = nil)
+      # Check for a cell reference in A1 notation and substitute row and column.
+      if (row_col_array = row_col_notation(row))
+        _row, _col = row_col_array
+        image      = col
+        _options   = filename
+      else
+        _row     = row
+        _col     = col
+        image    = filename
+        _options = options
+      end
+      xf, url, tip, description, decorative = []
+
+      raise WriteXLSXInsufficientArgumentError if [_row, _col, image].include?(nil)
+      raise "Couldn't locate #{image}" unless File.exist?(image)
+
+      # Check that row and col are valid and store max and min values
+      check_dimensions(_row, _col)
+      store_row_col_max_min_values(_row, _col)
+
+      if options
+        xf          = options[:cell_format]
+        url         = options[:url]
+        tip         = options[:tip]
+        description = options[:description]
+        decorative  = options[:decorative]
+      end
+
+      # Write the url without writing a string.
+      if url
+        xf ||= @default_url_format
+
+        write_url(row, col, url, xf, nil, tip, true)
+      end
+
+      # Get the image properties, mainly for the type and checksum.
+      image_properties = get_image_properties(image)
+      type = image_properties[0]
+      md5  = image_properties[6]
+
+      # Check for duplicate images.
+      image_index = @embedded_image_indexes[md5]
+
+      unless ptrue?(image_index)
+        @workbook.embedded_images << [image, type, description, decorative]
+
+        image_index = @workbook.embedded_images.size
+        @embedded_image_indexes[md5] = image_index
+      end
+
+      # Write the cell placeholder.
+      store_data_to_table(EmbedImageCellData.new(image_index, xf), _row, _col)
+      @has_embedded_images = true
+    end
+
     #
     # :call-seq:
     #   repeat_formula(row, column, formula [ , format ])
@@ -2755,8 +2864,12 @@ module Writexlsx
       end
     end
 
-    def has_dynamic_arrays?
-      @has_dynamic_arrays
+    def has_dynamic_functions?
+      @has_dynamic_functions
+    end
+
+    def has_embedded_images?
+      @has_embedded_images
     end
 
     private
@@ -2926,7 +3039,7 @@ module Writexlsx
       tokens.map! do |token|
         token.sub!(/^"/, '')
         token.sub!(/"$/, '')
-        token.gsub!(/""/, '"')
+        token.gsub!('""', '"')
 
         # if token is number, convert to numeric.
         if token =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/
@@ -3208,13 +3321,13 @@ module Writexlsx
           target = escape_url(url.sub(/^external:/, ''))
 
           # Additional escape not required in worksheet hyperlinks
-          target = target.gsub(/#/, '%23')
+          target = target.gsub("#", '%23')
 
           # Prefix absolute paths (not relative) with file:///
           target = if target =~ /^\w:/ || target =~ /^\\\\/
                      "file:///#{target}"
                    else
-                     target.gsub(/\\/, '/')
+                     target.gsub("\\", '/')
                    end
         end
 
@@ -3234,6 +3347,7 @@ EOS
       end
 
       @drawing_links << ['/image', "../media/image#{image_id}.#{image_type}"] unless @drawing_rels[md5]
+
       drawing.rel_index = drawing_rel_index(md5)
     end
     public :prepare_image
@@ -3437,7 +3551,7 @@ EOS
     def encode_password(password) # :nodoc:
       hash = 0
 
-      password.reverse.split(//).each do |char|
+      password.reverse.split("").each do |char|
         hash = ((hash >> 14) & 0x01) | ((hash << 1) & 0x7fff)
         hash ^= char.ord
       end
@@ -3559,16 +3673,27 @@ EOS
       attributes << ["showOutlineSymbols", 0] if @outline_on
 
       # Set the page view/layout mode if required.
-      # TODO. Add pageBreakPreview mode when requested.
-      attributes << %w[view pageLayout] if page_view?
+      case @page_view
+      when 1
+        attributes << %w[view pageLayout]
+      when 2
+        attributes << %w[view pageBreakPreview]
+      end
 
       # Set the first visible cell.
       attributes << ['topLeftCell', @top_left_cell] if ptrue?(@top_left_cell)
 
       # Set the zoom level.
       if @zoom != 100
-        attributes << ['zoomScale', @zoom] unless page_view?
-        attributes << ['zoomScaleNormal', @zoom] if zoom_scale_normal?
+        attributes << ['zoomScale', @zoom]
+
+        if @page_view == 1
+          attributes << ['zoomScalePageLayoutView', @zoom]
+        elsif @page_view == 2
+          attributes << ['zoomScaleSheetLayoutView', @zoom]
+        elsif ptrue?(@zoom_scale_normal)
+          attributes << ['zoomScaleNormal', @zoom]
+        end
       end
 
       attributes << ['workbookViewId', 0]
@@ -3754,9 +3879,10 @@ EOS
 
     def write_cell_column_dimension(row_num)  # :nodoc:
       row = @cell_data_table[row_num]
+      row_name = (row_num + 1).to_s
       (@dim_colmin..@dim_colmax).each do |col_num|
         if (cell = row[col_num])
-          cell.write_cell(self, row_num, col_num)
+          cell.write_cell(self, row_num, row_name, col_num)
         end
       end
     end
@@ -4200,9 +4326,10 @@ EOS
 
           # If the cell isn't a string then we have to add the url as
           # the string to display
-          if ptrue?(@cell_data_table)          &&
-             ptrue?(@cell_data_table[row_num]) &&
-             ptrue?(@cell_data_table[row_num][col_num]) && @cell_data_table[row_num][col_num].display_url_string?
+          if ptrue?(@cell_data_table)                   &&
+             ptrue?(@cell_data_table[row_num])          &&
+             ptrue?(@cell_data_table[row_num][col_num]) &&
+             @cell_data_table[row_num][col_num].display_url_string?
             link.display_on
           end
 
@@ -4755,10 +4882,6 @@ EOS
       ptrue?(@zoom_scale_normal)
     end
 
-    def page_view? # :nodoc:
-      !!@page_view
-    end
-
     def right_to_left? # :nodoc:
       !!@right_to_left
     end

data/write_xlsx.gemspec

@@ -20,9 +20,11 @@ Gem::Specification.new do |gem|
   end
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.require_paths = ['lib']
+  gem.add_runtime_dependency 'nkf'
   gem.add_runtime_dependency 'rubyzip', '>= 1.0.0'
   gem.add_development_dependency 'byebug'
   gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'mutex_m'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rubocop'
   gem.add_development_dependency 'rubocop-minitest'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: write_xlsx
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 1.12.0
 platform: ruby
 authors:
 - Hideo NAKAMURA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-08 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: nkf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -238,6 +266,10 @@ files:
 - lib/write_xlsx/package/metadata.rb
 - lib/write_xlsx/package/packager.rb
 - lib/write_xlsx/package/relationships.rb
+- lib/write_xlsx/package/rich_value.rb
+- lib/write_xlsx/package/rich_value_rel.rb
+- lib/write_xlsx/package/rich_value_structure.rb
+- lib/write_xlsx/package/rich_value_types.rb
 - lib/write_xlsx/package/shared_strings.rb
 - lib/write_xlsx/package/styles.rb
 - lib/write_xlsx/package/table.rb
@@ -276,7 +308,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: write_xlsx is a gem to create a new file in the Excel 2007+ XLSX format.