write_xlsx 1.07.0 → 1.08.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 677847fdb975ab7253b3a5ed5f6aa779a9bbf2a459e941f5037b7d557e2abfe4
-  data.tar.gz: 4c4b0b03ce3b510a0ad6423c30a76fc778463afe92f992da52b49bbe65c7a1ac
+  metadata.gz: 0bce1d8cc8f140d38ac7d9149e644d8b1d5133c80933fc2faa2a33d25dcbd168
+  data.tar.gz: 4edf0897d13ec8cee0b545177fe4117286067ba2e14b89c2866192885414633b
 SHA512:
-  metadata.gz: b3f81d2d54e5f7a7170c34e7666f58c7f4f77b993ff3b95263327b0ff8edff5c9a0b1a6ea825ece5b43c5b1d2b91a6f01764237f22ee6442bd8c747de8e04150
-  data.tar.gz: 3e49064459345dbcc5d97fef0f8154159776e8361cb0709e8a4564f32dd062fe95b6e4f08976df81b5ac478a40287be9a33086726444af3c75d1cbeb5c869dc2
+  metadata.gz: 267233a3a8222f817bc455b5d8723bf29808854a7b5410c090becd44baee604201b53792f03b29db84c2fa82f9a4085e11175893abb11bab50b1a74c9f0526e8
+  data.tar.gz: bc5138fcae79f92aaa9a5d6d708575e9615cec51e4c229ec46e0e75e45bc1eca37056f27466f321c8ad6376119bd37c61754b8809c991fd2352ca8a1108089f0

data/Changes

@@ -1,5 +1,36 @@
 Change history of write_xlsx rubygem.
 
+2021-11-19 v1.08.0
+
+    Added ability to add accessibility options "description" and
+    "decorative" to images via insert_image().
+
+    Added the workbook read_only_recommended() method to set the Excel
+    "Read-only Recommended" option that is available when saving a file.
+
+    Added option to set a chart crossing to 'min' as well as the existing
+    'max' option. The 'min' option isn't available in the Excel interface
+    but can be enabled via VBA.
+
+    Added option to unprotect ranges in protected worksheets.
+
+    Added check, and warning, for worksheet tables with no data row.  Either
+    with or without a header row.
+
+    Added ignore_errors() worksheet method to ignore Excel worksheet
+    errors/warnings in user defined ranges.
+
+    Fixed issue where pattern formats without colours where given a default
+    black fill colour.
+
+    Fix issue where custom chart data labels didn't inherit the position for
+    the data labels in the series.
+
+    Fixed issue with relative url links in images.
+
+    Fixed issue where headers/footers were restricted to 254 characters
+    instead of 255.
+
 2021-02-17 v1.07.0
 
    Added support for Border, Fill, Pattern and Gradient formatting to chart

data/README.md

@@ -5,7 +5,7 @@
 
 gem to create a new file in the Excel 2007+ XLSX format, and you can use the
 same interface as writeexcel gem. write_xlsx is converted from Perl's module
-[Excel::Writer::XLSX-1.07](https://github.com/jmcnamara/excel-writer-xlsx/tree/CPAN_1.07)
+[Excel::Writer::XLSX-1.08](https://github.com/jmcnamara/excel-writer-xlsx/tree/CPAN_1.08)
 
 ## Description
 

data/lib/write_xlsx/chart.rb

@@ -1397,7 +1397,7 @@ module Writexlsx
 
     def write_crossing(crossing)
       # Note, the category crossing comes from the value axis.
-      if nil_or_max?(crossing)
+      if [nil, 'max', 'min'].include?(crossing)
         # Write the c:crosses element.
         write_crosses(crossing)
       else
@@ -2418,12 +2418,14 @@ module Writexlsx
           elsif label[:formula]
             write_custom_label_formula(label)
 
+            write_d_lbl_pos(parent[:position]) if parent[:position]
             write_show_val      if parent[:value]
             write_show_cat_name if parent[:category]
             write_show_ser_name if parent[:series_name]
           elsif label[:value]
             write_custom_label_str(label)
 
+            write_d_lbl_pos(parent[:position]) if parent[:position]
             write_show_val      if parent[:value]
             write_show_cat_name if parent[:category]
             write_show_ser_name if parent[:series_name]
@@ -2926,9 +2928,5 @@ module Writexlsx
         @writer.empty_tag(tag)
       end
     end
-
-    def nil_or_max?(val)  # :nodoc:
-      val.nil? || val == 'max'
-    end
   end
 end

data/lib/write_xlsx/drawing.rb

@@ -5,11 +5,11 @@ require 'write_xlsx/utility'
 module Writexlsx
   class Drawing
     attr_accessor :type, :dimensions, :width, :height, :description, :shape, :anchor, :rel_index, :url_rel_index
-    attr_reader :tip
+    attr_reader :tip, :decorative
 
-    def initialize(type, dimensions, width, height, description, shape, anchor, rel_index = nil, url_rel_index = nil, tip = nil)
-      @type, @dimensions, @width, @height, @description, @shape, @anchor, @rel_index, @url_rel_index, @tip =
-        type, dimensions, width, height, description, shape, anchor, rel_index, url_rel_index, tip
+    def initialize(type, dimensions, width, height, description, shape, anchor, rel_index = nil, url_rel_index = nil, tip = nil, decorative = nil)
+      @type, @dimensions, @width, @height, @description, @shape, @anchor, @rel_index, @url_rel_index, @tip, @decorative =
+        type, dimensions, width, height, description, shape, anchor, rel_index, url_rel_index, tip, decorative
     end
   end
 
@@ -92,6 +92,7 @@ module Writexlsx
       rel_index     = drawing.rel_index
       url_rel_index = drawing.url_rel_index
       tip           = drawing.tip
+      decorative    = drawing.decorative
 
       col_from, row_from, col_from_offset, row_from_offset,
       col_to, row_to, col_to_offset, row_to_offset, col_absolute, row_absolute = drawing.dimensions
@@ -124,7 +125,7 @@ module Writexlsx
           write_pic(
             index,        rel_index,      col_absolute,
             row_absolute, width,          height,
-            description,  url_rel_index , tip
+            description,  url_rel_index , tip, decorative
           )
         else
           # Write the xdr:sp element for shapes.
@@ -148,13 +149,13 @@ module Writexlsx
           write_pos(0, 0)
 
           # Write the xdr:ext element.
-          write_ext(9308969, 6078325)
+          write_xdr_ext(9308969, 6078325)
         else
           # Write the xdr:pos element.
           write_pos(0, -47625)
 
           # Write the xdr:ext element.
-          write_ext(6162675, 6124575)
+          write_xdr_ext(6162675, 6124575)
         end
 
         # Write the xdr:graphicFrame element.
@@ -242,7 +243,7 @@ module Writexlsx
     #
     # Write the <xdr:ext> element.
     #
-    def write_ext(cx, cy)
+    def write_xdr_ext(cx, cy)
       attributes = [
         ['cx', cx],
         ['cy', cy]
@@ -286,19 +287,25 @@ module Writexlsx
     #
     # Write the <xdr:cNvPr> element.
     #
-    def write_c_nv_pr(index, name, description = nil, url_rel_index = nil, tip = nil)
+    def write_c_nv_pr(index, name, description = nil, url_rel_index = nil, tip = nil, decorative = nil)
       attributes = [
         ['id',   index],
         ['name', name]
       ]
 
       # Add description attribute for images.
-      attributes << ['descr', description] if description
+      attributes << ['descr', description] if ptrue?(description) && !ptrue?(decorative)
 
-      if ptrue?(url_rel_index)
+      if ptrue?(url_rel_index) || ptrue?(decorative)
         @writer.tag_elements('xdr:cNvPr', attributes) do
-          # Write the a:hlinkClick element.
-          write_a_hlink_click(url_rel_index, tip)
+          if ptrue?(url_rel_index)
+            # Write the a:hlinkClick element.
+            write_a_hlink_click(url_rel_index, tip)
+          end
+          if ptrue?(decorative)
+            # Write the adec:decorative element.
+            write_decorative
+          end
         end
       else
         @writer.empty_tag('xdr:cNvPr', attributes)
@@ -323,6 +330,62 @@ module Writexlsx
       @writer.empty_tag('a:hlinkClick', attributes)
     end
 
+    #
+    # Write the <adec:decorative> element.
+    #
+    def write_decorative
+      @writer.tag_elements('a:extLst') do
+        write_a_uri_ext('{FF2B5EF4-FFF2-40B4-BE49-F238E27FC236}')
+        write_a16_creation_id
+        @writer.end_tag('a:ext')
+
+        write_a_uri_ext('{C183D7F6-B498-43B3-948B-1728B52AA6E4}')
+        write_adec_decorative
+        @writer.end_tag('a:ext')
+      end
+    end
+
+    #
+    # Write the <a:ext> element.
+    #
+    def write_a_uri_ext(uri)
+      attributes = [
+        ['uri', uri]
+      ]
+
+      @writer.start_tag('a:ext', attributes)
+    end
+
+    #
+    # Write the <adec:decorative> element.
+    #
+    def write_adec_decorative
+      xmlns_adec = 'http://schemas.microsoft.com/office/drawing/2017/decorative'
+      val        = 1
+
+      attributes = [
+        ['xmlns:adec', xmlns_adec],
+        ['val',        val]
+      ]
+
+      @writer.empty_tag('adec:decorative', attributes)
+    end
+
+    #
+    # Write the <a16:creationId> element.
+    #
+    def write_a16_creation_id
+      xmlns_a_16 = 'http://schemas.microsoft.com/office/drawing/2014/main'
+      id         = '{00000000-0008-0000-0000-000002000000}'
+
+      attributes = [
+        ['xmlns:a16', xmlns_a_16],
+        ['id',        id]
+      ]
+
+      @writer.empty_tag('a16:creationId', attributes)
+    end
+
     #
     # Write the <xdr:cNvGraphicFramePr> element.
     #
@@ -527,10 +590,10 @@ module Writexlsx
     #
     # Write the <xdr:pic> element.
     #
-    def write_pic(index, rel_index, col_absolute, row_absolute, width, height, description, url_rel_index, tip)
+    def write_pic(index, rel_index, col_absolute, row_absolute, width, height, description, url_rel_index, tip, decorative)
       @writer.tag_elements('xdr:pic') do
         # Write the xdr:nvPicPr element.
-        write_nv_pic_pr(index, rel_index, description, url_rel_index, tip)
+        write_nv_pic_pr(index, rel_index, description, url_rel_index, tip, decorative)
         # Write the xdr:blipFill element.
         write_blip_fill(rel_index)
 
@@ -546,12 +609,12 @@ module Writexlsx
     #
     # Write the <xdr:nvPicPr> element.
     #
-    def write_nv_pic_pr(index, rel_index, description, url_rel_index, tip)
+    def write_nv_pic_pr(index, rel_index, description, url_rel_index, tip, decorative)
       @writer.tag_elements('xdr:nvPicPr') do
         # Write the xdr:cNvPr element.
         write_c_nv_pr(
           index + 1, "Picture #{index}", description,
-          url_rel_index, tip
+          url_rel_index, tip, decorative
         )
         # Write the xdr:cNvPicPr element.
         write_c_nv_pic_pr

data/lib/write_xlsx/package/app.rb

@@ -7,6 +7,7 @@ module Writexlsx
     class App
 
       include Writexlsx::Utility
+      attr_writer :doc_security
 
       def initialize(workbook)
         @writer = Package::XMLWriterSimple.new
@@ -14,6 +15,7 @@ module Writexlsx
         @part_names    = []
         @heading_pairs = []
         @properties    = {}
+        @doc_security  = 0
       end
 
       def set_xml_writer(filename)
@@ -123,9 +125,7 @@ module Writexlsx
       # Write the <DocSecurity> element.
       #
       def write_doc_security
-        data = 0
-
-        @writer.data_element('DocSecurity', data)
+        @writer.data_element('DocSecurity', @doc_security)
       end
 
       #

data/lib/write_xlsx/package/conditional_format.rb

@@ -397,14 +397,8 @@ module Writexlsx
       def range_start_cell_for_conditional_formatting(*args)  # :nodoc:
         row1, row2, col1, col2, user_range, param =
                                             row_col_param_for_conditional_formatting(*args)
-        # If the first and last cell are the same write a single cell.
-        if row1 == row2 && col1 == col2
-          range = xl_rowcol_to_cell(row1, col1)
-          @start_cell = range
-        else
-          range = xl_range(row1, row2, col1, col2)
-          @start_cell = xl_rowcol_to_cell(row1, col1)
-        end
+        range       = xl_range(row1, row2, col1, col2)
+        @start_cell = xl_rowcol_to_cell(row1, col1)
 
         # Override with user defined multiple range if provided.
         range = user_range if user_range

data/lib/write_xlsx/package/packager.rb

@@ -155,6 +155,7 @@ module Writexlsx
         app.add_named_ranges_parts
 
         app.set_properties(@workbook.doc_properties)
+        app.doc_security = @workbook.read_only
 
         FileUtils.mkdir_p("#{@package_dir}/docProps")
         app.set_xml_writer("#{@package_dir}/docProps/app.xml")

data/lib/write_xlsx/package/styles.rb

@@ -253,11 +253,22 @@ module Writexlsx
       # Write the <fill> element.
       #
       def write_fill(format, dxf_format = nil)
-        @writer.tag_elements('fill' ) do
-          write_fill_base(format, dxf_format)
+        # Special handling for pattern only case.
+        if pattern_only_case?(format, dxf_format)
+          write_default_fill(PATTERNS[format.pattern])
+        else
+          @writer.tag_elements('fill' ) do
+            write_fill_base(format, dxf_format)
+          end
         end
       end
 
+      def pattern_only_case?(format, dxf_format)
+        bg_color, fg_color = bg_and_fg_color(format, dxf_format)
+
+        !ptrue?(fg_color) && !ptrue?(bg_color) && ptrue?(format.pattern)
+      end
+
       def write_fill_base(format, dxf_format)
         # The "none" pattern is handled differently for dxf formats.
         if dxf_format && format.pattern <= 1
@@ -281,7 +292,9 @@ module Writexlsx
         if bg_color && bg_color != 0
           @writer.empty_tag('bgColor', [ ['rgb', palette_color(bg_color)] ])
         else
-          @writer.empty_tag('bgColor', [ ['indexed', 64] ]) if !dxf_format
+          if !dxf_format && format.pattern <= 1
+            @writer.empty_tag('bgColor', [ ['indexed', 64] ])
+          end
         end
       end
 

data/lib/write_xlsx/utility.rb

@@ -60,7 +60,11 @@ module Writexlsx
       range1 = xl_rowcol_to_cell(row_1, col_1, row_abs_1, col_abs_1)
       range2 = xl_rowcol_to_cell(row_2, col_2, row_abs_2, col_abs_2)
 
-      "#{range1}:#{range2}"
+      if range1 == range2
+        range1
+      else
+        "#{range1}:#{range2}"
+      end
     end
 
     def xl_range_formula(sheetname, row_1, row_2, col_1, col_2)

data/lib/write_xlsx/version.rb

@@ -1 +1 @@
-WriteXLSX_VERSION = "1.07.0"
+WriteXLSX_VERSION = "1.08.0"

data/lib/write_xlsx/workbook.rb

@@ -52,6 +52,7 @@ module Writexlsx
     attr_reader :max_url_length # :nodoc:
     attr_reader :strings_to_urls # :nodoc:
     attr_reader :default_url_format # :nodoc:
+    attr_reader :read_only # :nodoc:
 
     #
     # A new Excel workbook is created using the +new+ constructor
@@ -133,6 +134,7 @@ module Writexlsx
 
       @max_url_length      = 2079
       @has_comments        = false
+      @read_only           = 0
       if options[:max_url_length]
         @max_url_length = options[:max_url_length]
 
@@ -292,6 +294,9 @@ module Writexlsx
           # Write the XLSX file version.
           write_file_version
 
+          # Write the fileSharing element.
+          write_file_sharing
+
           # Write the workbook properties.
           write_workbook_pr
 
@@ -954,6 +959,13 @@ module Writexlsx
       end
     end
 
+    #
+    # Set the Excel "Read-only recommended" save option.
+    #
+    def read_only_recommended
+      @read_only = 2
+    end
+
     #
     # set_calc_mode()
     #
@@ -1311,6 +1323,17 @@ module Writexlsx
       @writer.empty_tag('fileVersion', attributes)
     end
 
+    #
+    # Write the <fileSharing> element.
+    #
+    def write_file_sharing
+      return if !ptrue?(@read_only)
+
+      attributes = []
+      attributes << ['readOnlyRecommended', 1]
+      @writer.empty_tag('fileSharing', attributes)
+    end
+
     def write_workbook_pr #:nodoc:
       attributes = []
       attributes << ['codeName', @vba_codename]  if ptrue?(@vba_codename)

data/lib/write_xlsx/worksheet/data_validation.rb

@@ -138,12 +138,7 @@ module Writexlsx
           row_first, row_last = row_last, row_first if row_first > row_last
           col_first, col_last = col_last, col_first if col_first > col_last
 
-          # If the first and last cell are the same write a single cell.
-          if row_first == row_last && col_first == col_last
-            sqref += xl_rowcol_to_cell(row_first, col_first)
-          else
-            sqref += xl_range(row_first, row_last, col_first, col_last)
-          end
+          sqref += xl_range(row_first, row_last, col_first, col_last)
         end
 
         if @validate != 'none'

data/lib/write_xlsx/worksheet.rb

@@ -388,6 +388,9 @@ module Writexlsx
       @data_bars_2010 = []
       @dxf_priority   = 1
 
+      @protected_ranges     = []
+      @num_protected_ranges = 0
+
       if excel2003_style?
         @original_row_height      = 12.75
         @default_row_height       = 12.75
@@ -414,6 +417,7 @@ module Writexlsx
           write_cols
           write_sheet_data
           write_sheet_protection
+          write_protected_ranges
           # write_sheet_calc_pr
           write_phonetic_pr if excel2003_style?
           write_auto_filter
@@ -616,7 +620,25 @@ module Writexlsx
 
       # Set the password after the user defined values.
       @protect[:password] =
-        sprintf("%X", encode_password(password)) if password && password != ''
+        encode_password(password) if password && password != ''
+    end
+
+    #
+    # Unprotect ranges within a protected worksheet.
+    #
+    def unprotect_range(range, range_name = nil, password = nil)
+      if range.nil?
+        raise "The range must be defined in unprotect_range())\n"
+      else
+        range.gsub!(/\$/, "")
+        range.sub!(/^=/, "")
+        @num_protected_ranges += 1
+      end
+
+      range_name ||= "Range#{@num_protected_ranges}"
+      password   &&= encode_password(password)
+
+      @protected_ranges << [range, range_name, password]
     end
 
     def protect_default_settings  # :nodoc:
@@ -818,12 +840,7 @@ module Writexlsx
         row_first, row_last = row_last, row_first if row_first > row_last
         col_first, col_last = col_last, col_first if col_first > col_last
 
-        # If the first and last cell are the same write a single cell.
-        if row_first == row_last && col_first == col_last
-          sqref = active_cell
-        else
-          sqref = xl_range(row_first, row_last, col_first, col_last)
-        end
+        sqref = xl_range(row_first, row_last, col_first, col_last)
       else          # Single cell selection.
         sqref = active_cell
       end
@@ -3048,14 +3065,16 @@ module Writexlsx
 
       if options.first.class == Hash
         # Newer hash bashed options
-        params = options.first
-        x_offset = params[:x_offset]
-        y_offset = params[:y_offset]
-        x_scale  = params[:x_scale]
-        y_scale  = params[:y_scale]
-        anchor   = params[:object_position]
-        url      = params[:url]
-        tip      = params[:tip]
+        params      = options.first
+        x_offset    = params[:x_offset]
+        y_offset    = params[:y_offset]
+        x_scale     = params[:x_scale]
+        y_scale     = params[:y_scale]
+        anchor      = params[:object_position]
+        url         = params[:url]
+        tip         = params[:tip]
+        description = params[:description]
+        decorative  = params[:decorative]
       else
         x_offset, y_offset, x_scale, y_scale, anchor = options
       end
@@ -3067,7 +3086,7 @@ module Writexlsx
 
       @images << [
         row, col, image, x_offset, y_offset,
-        x_scale, y_scale, url, tip, anchor
+        x_scale, y_scale, url, tip, anchor, description, decorative
       ]
     end
 
@@ -5744,7 +5763,7 @@ module Writexlsx
       name = chart.name
 
       # Create a Drawing object to use with worksheet unless one already exists.
-      drawing = Drawing.new(drawing_type, dimensions, 0, 0, name, nil, anchor, drawing_rel_index, 0, nil)
+      drawing = Drawing.new(drawing_type, dimensions, 0, 0, name, nil, anchor, drawing_rel_index, 0, nil, 0)
       if !drawings?
         @drawings = Drawings.new
         @drawings.add_drawing_object(drawing)
@@ -6470,7 +6489,7 @@ module Writexlsx
       drawing_type = 2
 
       row, col, image, x_offset, y_offset,
-      x_scale, y_scale, url, tip, anchor = @images[index]
+      x_scale, y_scale, url, tip, anchor, description, decorative = @images[index]
 
       width  *= x_scale
       height *= y_scale
@@ -6485,7 +6504,7 @@ module Writexlsx
       height = (0.5 + (height * 9_525)).to_i
 
       # Create a Drawing object to use with worksheet unless one already exists.
-      drawing = Drawing.new(drawing_type, dimensions, width, height, name, nil, anchor, 0, 0, tip)
+      drawing = Drawing.new(drawing_type, dimensions, width, height, name, nil, anchor, 0, 0, tip, decorative)
       if !drawings?
         drawings = Drawings.new
         drawings.embedded = 1
@@ -6498,6 +6517,10 @@ module Writexlsx
       end
       drawings.add_drawing_object(drawing)
 
+      if description
+        drawing.description = description
+      end
+
       if url
         rel_type = '/hyperlink'
         target_mode = 'External'
@@ -6651,7 +6674,7 @@ EOS
       shape.calc_position_emus(self)
 
       drawing_type = 3
-      drawing = Drawing.new(drawing_type, shape.dimensions, shape.width_emu, shape.height_emu, shape.name, shape, shape.anchor, drawing_rel_index, 0, nil)
+      drawing = Drawing.new(drawing_type, shape.dimensions, shape.width_emu, shape.height_emu, shape.name, shape, shape.anchor, drawing_rel_index, 0, nil, 0)
       drawings.add_drawing_object(drawing)
     end
     public :prepare_shape
@@ -6741,6 +6764,8 @@ EOS
       chars.each { |c| encoded_password ^= c }
       encoded_password ^= count
       encoded_password ^= 0xCE4B
+
+      sprintf("%X", encoded_password)
     end
 
     #
@@ -7556,6 +7581,32 @@ EOS
       @writer.empty_tag('sheetProtection', attributes)
     end
 
+    #
+    # Write the <protectedRanges> element.
+    #
+    def write_protected_ranges
+      return if @num_protected_ranges == 0
+
+      @writer.tag_elements('protectedRanges') do
+        @protected_ranges.each do |protected_range|
+          write_protected_range(*protected_range)
+        end
+      end
+    end
+
+    #
+    # Write the <protectedRange> element.
+    #
+    def write_protected_range(sqref, name, password)
+      attributes = []
+
+      attributes << ['password', password] if password
+      attributes << ['sqref',    sqref]
+      attributes << ['name',     name]
+
+      @writer.empty_tag('protectedRange', attributes)
+    end
+
     #
     # Write the <drawing> elements.
     #

data/test/drawing/{test_write_ext.rb → test_write_xdr_ext.rb}

@@ -2,7 +2,7 @@
 require 'helper'
 require 'write_xlsx/drawing'
 
-class TestWriteExt < Minitest::Test
+class TestWriteXdrExt < Minitest::Test
   def setup
     @drawing = Writexlsx::Drawings.new
   end
@@ -10,7 +10,7 @@ class TestWriteExt < Minitest::Test
   def test_write_ext
     expected = '<xdr:ext cx="9308969" cy="6078325"/>'
 
-    @drawing.__send__(:write_ext, 9308969, 6078325)
+    @drawing.__send__(:write_xdr_ext, 9308969, 6078325)
     result = @drawing.instance_variable_get(:@writer).string
 
     assert_equal(expected, result)

data/test/regression/test_chart_crossing01.rb

@@ -33,7 +33,7 @@ class TestRegressionChartCrossing01 < Minitest::Test
 
     chart.set_y_axis(:crossing => 'max')
 
-    # Not stictly required. Just to match reference file.
+    # Not strictly required. Just to match reference file.
     chart.set_x_axis(:position => 't')
 
     worksheet.insert_chart('E9', chart)