write_xlsx 1.02.0 → 1.08.1

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

@@ -248,11 +248,11 @@ module Writexlsx
     #
     def copy(other)
       reserve = [
-                 :xf_index,
-                 :dxf_index,
-                 :xdf_format_indices,
-                 :palette
-                ]
+        :xf_index,
+        :dxf_index,
+        :xdf_format_indices,
+        :palette
+      ]
       (instance_variables - reserve).each do |v|
         instance_variable_set(v, other.instance_variable_get(v))
       end

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

@@ -155,7 +155,7 @@ module Writexlsx
       #
       def fill_attributes
         [
-         ['color2', '#ffffe1']
+          ['color2', '#ffffe1']
         ]
       end
 
@@ -164,9 +164,9 @@ module Writexlsx
       #
       def write_shadow
         attributes = [
-            ['on',       't'],
-            ['color',    'black'],
-            ['obscured', 't']
+          ['on',       't'],
+          ['color',    'black'],
+          ['obscured', 't']
         ]
 
         @writer.empty_tag('v:shadow', attributes)

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

@@ -64,8 +64,8 @@ module Writexlsx
       #
       def write_relationships
         attributes = [
-                      ['xmlns', Package_schema]
-                     ]
+          ['xmlns', Package_schema]
+        ]
 
         @writer.tag_elements('Relationships', attributes) do
           @rels.each { |rel| write_relationship(*rel) }

data/lib/write_xlsx/package/styles.rb

@@ -20,6 +20,7 @@ module Writexlsx
         @dxf_formats       = []
         @has_hyperlink     = 0
         @hyperlink_font_id = 0
+        @has_comments      = false
       end
 
       def set_xml_writer(filename)
@@ -37,7 +38,7 @@ module Writexlsx
       #
       def set_style_properties(
             xf_formats, palette, font_count, num_format_count, border_count,
-            fill_count, custom_colors, dxf_formats
+            fill_count, custom_colors, dxf_formats, has_comments
           )
         @xf_formats       = xf_formats
         @palette          = palette
@@ -47,6 +48,7 @@ module Writexlsx
         @fill_count       = fill_count
         @custom_colors    = custom_colors
         @dxf_formats      = dxf_formats
+        @has_comments     = has_comments
       end
 
       #
@@ -148,7 +150,14 @@ module Writexlsx
       # Write the <fonts> element.
       #
       def write_fonts
-        write_format_elements('fonts', @font_count) do
+        count = @font_count
+
+        if @has_comments
+          # Add an extra font for comments.
+          count += 1
+        end
+
+        write_format_elements('fonts', count) do
           write_font_base
         end
       end
@@ -161,6 +170,21 @@ module Writexlsx
             @hyperlink_font_id = format.font_index unless ptrue?(@hyperlink_font_id)
           end
         end
+        if @has_comments
+          write_comment_font
+        end
+      end
+
+      #
+      # Write the <font> element used for comments.
+      #
+      def write_comment_font
+        @writer.tag_elements('font') do
+          @writer.empty_tag('sz', [['val', 8]])
+          write_color('indexed', 81)
+          @writer.empty_tag( 'name',   [['val', 'Tahoma']])
+          @writer.empty_tag( 'family', [['val', 2]])
+        end
       end
 
       #
@@ -229,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
@@ -257,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
 
@@ -394,12 +431,6 @@ module Writexlsx
       def write_cell_xfs
         formats = @xf_formats
 
-        # Workaround for when the last format is used for the comment font
-        # and shouldn't be used for cellXfs.
-        last_format =   formats[-1]
-
-        formats.pop if last_format && last_format.font_only != 0
-
         attributes = [ ['count', formats.size] ]
 
         @writer.tag_elements('cellXfs', attributes) do

data/lib/write_xlsx/package/table.rb

@@ -189,6 +189,14 @@ module Writexlsx
         param[:header_row]  ||= 1
         param[:autofilter]  ||= 1
 
+        # Check that there are enough rows.
+        num_rows = row2 - row1
+        num_rows -= 1 if ptrue?(param[:header_row])
+
+        if num_rows < 0
+          raise "Must have at least one data row in in add_table()"
+        end
+
         # If the header row if off the default is to turn autofilter off.
         param[:autofilter] = 0 if param[:header_row] == 0
 
@@ -398,13 +406,14 @@ module Writexlsx
       # Write the <tableStyleInfo> element.
       #
       def write_table_style_info
-        attributes = [
-                      ['name',              @style],
-                      ['showFirstColumn',   @show_first_col],
-                      ['showLastColumn',    @show_last_col],
-                      ['showRowStripes',    @show_row_stripes],
-                      ['showColumnStripes', @show_col_stripes]
-                     ]
+        attributes = []
+        if @style && @style != '' && @style != 'None'
+          attributes << ['name', @style]
+        end
+        attributes << ['showFirstColumn',   @show_first_col]
+        attributes << ['showLastColumn',    @show_last_col]
+        attributes << ['showRowStripes',    @show_row_stripes]
+        attributes << ['showColumnStripes', @show_col_stripes]
 
         @writer.empty_tag('tableStyleInfo', attributes)
       end

data/lib/write_xlsx/package/vml.rb

@@ -17,9 +17,9 @@ module Writexlsx
       end
 
       def assemble_xml_file(
-                            data_id, vml_shape_id, comments_data,
-                            buttons_data, header_images_data = []
-                            )
+            data_id, vml_shape_id, comments_data,
+            buttons_data, header_images_data = []
+          )
         return unless @writer
 
         write_xml_namespace do
@@ -29,9 +29,9 @@ module Writexlsx
           z_index = 1
           unless buttons_data.empty?
             vml_shape_id, z_index =
-              write_shape_type_and_shape(
-                                         buttons_data,
-                                         vml_shape_id, z_index) do
+                          write_shape_type_and_shape(
+                            buttons_data,
+                            vml_shape_id, z_index) do
               write_button_shapetype
             end
           end
@@ -277,6 +277,7 @@ module Writexlsx
         position = image_data[3]
         x_dpi    = image_data[4]
         y_dpi    = image_data[5]
+        ref_id   = image_data[6]
 
         # Scale the height/width by the resolution, relative to 72dpi.
         width  = width  * 72.0 / x_dpi
@@ -294,20 +295,20 @@ module Writexlsx
         end
 
         style = [
-                 "position:absolute", "margin-left:0", "margin-top:0",
-                 "width:#{width}pt", "height:#{height}pt",
-                 "z-index:#{index}"
-                ].join(';')
+          "position:absolute", "margin-left:0", "margin-top:0",
+          "width:#{width}pt", "height:#{height}pt",
+          "z-index:#{index}"
+        ].join(';')
         attributes = [
-                      ['id',     position],
-                      ['o:spid', "_x0000_s#{id}"],
-                      ['type',   type],
-                      ['style',  style]
-                     ]
+          ['id',     position],
+          ['o:spid', "_x0000_s#{id}"],
+          ['type',   type],
+          ['style',  style]
+        ]
 
         @writer.tag_elements('v:shape', attributes) do
           # Write the v:imagedata element.
-          write_imagedata(index, name)
+          write_imagedata(ref_id, name)
 
           # Write the o:lock element.
           write_rotation_lock
@@ -319,9 +320,9 @@ module Writexlsx
       #
       def write_imagedata(index, o_title)
         attributes = [
-                      ['o:relid', "rId#{index}"],
-                      ['o:title', o_title]
-                     ]
+          ['o:relid', "rId#{index}"],
+          ['o:title', o_title]
+        ]
 
         @writer.empty_tag('v:imagedata', attributes)
       end

data/lib/write_xlsx/sheets.rb

@@ -67,18 +67,18 @@ module Writexlsx
           vml = Package::Vml.new
           vml.set_xml_writer("#{dir}/vmlDrawing#{index}.vml")
           vml.assemble_xml_file(
-                                sheet.vml_data_id, sheet.vml_shape_id,
-                                sheet.sorted_comments, sheet.buttons_data
-                                )
+            sheet.vml_data_id, sheet.vml_shape_id,
+            sheet.sorted_comments, sheet.buttons_data
+          )
           index += 1
         end
         if sheet.has_header_vml?
           vml = Package::Vml.new
           vml.set_xml_writer("#{dir}/vmlDrawing#{index}.vml")
           vml.assemble_xml_file(
-                                sheet.vml_header_id, sheet.vml_header_id * 1024,
-                                [], [], sheet.header_images_data
-                                )
+            sheet.vml_header_id, sheet.vml_header_id * 1024,
+            [], [], sheet.header_images_data
+          )
           write_vml_drawing_rels_files(package_dir, sheet, index)
           index += 1
         end
@@ -106,16 +106,12 @@ module Writexlsx
     end
 
     def write_chartsheet_rels_files(package_dir)
-      write_sheet_rels_files_base(chartsheets, "#{package_dir}/xl/chartsheets/_rels",
-                            'sheet')
+      write_sheet_rels_files_base(
+        chartsheets, "#{package_dir}/xl/chartsheets/_rels", 'sheet'
+      )
     end
 
     def write_drawing_rels_files(package_dir)
-      # write_rels_files_base(
-      #                       self.reject { |sheet| sheet.drawing_links[0].empty? },
-      #                       "#{package_dir}/xl/drawings/_rels",
-
-      #                       )
       dir = "#{package_dir}/xl/drawings/_rels"
 
       index = 0
@@ -159,8 +155,9 @@ module Writexlsx
     end
 
     def write_worksheet_rels_files(package_dir)
-      write_sheet_rels_files_base(worksheets, "#{package_dir}/xl/worksheets/_rels",
-                            'sheet')
+      write_sheet_rels_files_base(
+        worksheets, "#{package_dir}/xl/worksheets/_rels", 'sheet'
+      )
     end
 
     def write_sheet_rels_files_base(sheets, dir, body)
@@ -235,11 +232,6 @@ module Writexlsx
         raise "Worksheet name #{name} cannot start or end with an "
       end
 
-      # Check that sheetname isn't a reserved word.
-      if name =~ /history/i
-        raise "Worksheet name cannot be Excel reserved word 'History'"
-      end
-
       # Check that the worksheet name doesn't already exist since this is a fatal
       # error in Excel 97. The check must also exclude case insensitive matches.
       unless is_sheetname_uniq?(name)

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)
@@ -804,9 +808,9 @@ module Writexlsx
     #
     # Write the <c:txPr> element.
     #
-    def write_tx_pr(is_y_axis, font) # :nodoc:
+    def write_tx_pr(font, is_y_axis = nil) # :nodoc:
       rotation = nil
-      if font && font[:_rotation]
+      if font && font.respond_to?(:[]) && font[:_rotation]
         rotation = font[:_rotation]
       end
       @writer.tag_elements('c:txPr') do
@@ -903,6 +907,7 @@ module Writexlsx
     #
     def get_font_latin_attributes(font)
       return [] unless font
+      return [] unless font.respond_to?(:[])
 
       attributes = []
       attributes << ['typeface', font[:_name]]            if ptrue?(font[:_name])
@@ -959,6 +964,7 @@ module Writexlsx
     #
     def get_font_style_attributes(font)
       return [] unless font
+      return [] unless font.respond_to?(:[])
 
       attributes = []
       attributes << ['sz', font[:_size]]      if ptrue?(font[:_size])

data/lib/write_xlsx/version.rb

@@ -1 +1 @@
-WriteXLSX_VERSION = "1.02.0"
+WriteXLSX_VERSION = "1.08.1"