write_xlsx 1.04.0 → 1.08.2

data/lib/write_xlsx/chart.rb

@@ -34,7 +34,7 @@ module Writexlsx
         @writer.empty_tag('c:showOutline',    attributes) if ptrue?(outline)
         @writer.empty_tag('c:showKeys',       attributes) if ptrue?(show_keys)
         # Write the table font.
-        write_tx_pr(nil, font)                            if ptrue?(font)
+        write_tx_pr(font)                                 if ptrue?(font)
       end
     end
 
@@ -783,7 +783,7 @@ module Writexlsx
         elsif @title.formula
           write_title_formula(@title, nil, nil, @title.layout, @title.overlay)
         elsif @title.name
-          write_title_rich(@title, nil, @title.layout, @title.overlay)
+          write_title_rich(@title, nil, @title.name_font, @title.layout, @title.overlay)
         end
 
         # Write the c:plotArea element.
@@ -1204,7 +1204,7 @@ module Writexlsx
         if x_axis.formula
           write_title_formula(x_axis, is_y_axis, @x_axis, x_axis.layout)
         elsif x_axis.name
-          write_title_rich(x_axis, is_y_axis, x_axis.layout)
+          write_title_rich(x_axis, is_y_axis, x_axis.name_font, x_axis.layout)
         end
 
         # Write the c:numFmt element.
@@ -1281,7 +1281,7 @@ module Writexlsx
         if y_axis.formula
           write_title_formula(y_axis, @horiz_val_axis, nil, y_axis.layout)
         elsif y_axis.name
-          write_title_rich(y_axis, @horiz_val_axis, y_axis.layout)
+          write_title_rich(y_axis, @horiz_val_axis, y_axis.name_font, y_axis.layout)
         end
 
         # Write the c:numberFormat element.
@@ -1356,7 +1356,7 @@ module Writexlsx
         if x_axis.formula
           write_title_formula(x_axis, nil, nil, x_axis.layout)
         elsif x_axis.name
-          write_title_rich(x_axis, nil, x_axis.layout)
+          write_title_rich(x_axis, nil, x_axis.name_font, x_axis.layout)
         end
         # Write the c:numFmt element.
         write_number_format(x_axis)
@@ -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
@@ -1693,7 +1693,7 @@ module Writexlsx
         # Write the c:spPr element.
         write_sp_pr(@legend)
         # Write the c:txPr element.
-        write_tx_pr(nil, @legend.font) if ptrue?(@legend.font)
+        write_tx_pr(@legend.font) if ptrue?(@legend.font)
       end
     end
 
@@ -1808,10 +1808,10 @@ module Writexlsx
     #
     # Write the <c:title> element for a rich string.
     #
-    def write_title_rich(title, is_y_axis = nil, layout = nil, overlay = nil) # :nodoc:
+    def write_title_rich(title, is_y_axis, font, layout, overlay = nil) # :nodoc:
       @writer.tag_elements('c:title') do
         # Write the c:tx element.
-        write_tx_rich(title, is_y_axis)
+        write_tx_rich(title, is_y_axis, font)
         # Write the c:layout element.
         write_layout(layout, 'text')
         # Write the c:overlay element.
@@ -1831,15 +1831,17 @@ module Writexlsx
         # Write the c:overlay element.
         write_overlay if overlay
         # Write the c:txPr element.
-        write_tx_pr(is_y_axis, axis ? axis.name_font : title.name_font)
+        write_tx_pr(axis ? axis.name_font : title.name_font, is_y_axis)
       end
     end
 
     #
     # Write the <c:tx> element.
     #
-    def write_tx_rich(title, is_y_axis) # :nodoc:
-      @writer.tag_elements('c:tx') { write_rich(title, is_y_axis) }
+    def write_tx_rich(title, is_y_axis, font) # :nodoc:
+      @writer.tag_elements('c:tx') do
+        write_rich(title, font, is_y_axis)
+      end
     end
 
     #
@@ -1861,10 +1863,11 @@ module Writexlsx
     #
     # Write the <c:rich> element.
     #
-    def write_rich(title, is_y_axis) # :nodoc:
+    def write_rich(title, font, is_y_axis, ignore_rich_pr = false) # :nodoc:
       rotation = nil
-      if title.name_font && title.name_font[:_rotation]
-        rotation = title.name_font[:_rotation]
+
+      if font && font[:_rotation]
+        rotation = font[:_rotation]
       end
       @writer.tag_elements('c:rich') do
         # Write the a:bodyPr element.
@@ -1872,18 +1875,18 @@ module Writexlsx
         # Write the a:lstStyle element.
         write_a_lst_style
         # Write the a:p element.
-        write_a_p_rich(title)
+        write_a_p_rich(title, font, ignore_rich_pr)
       end
     end
     #
     # Write the <a:p> element for rich string titles.
     #
-    def write_a_p_rich(title) # :nodoc:
+    def write_a_p_rich(title, font, ignore_rich_pr) # :nodoc:
       @writer.tag_elements('a:p') do
         # Write the a:pPr element.
-        write_a_p_pr_rich(title.name_font)
+        write_a_p_pr_rich(font) if !ignore_rich_pr
         # Write the a:r element.
-        write_a_r(title)
+        write_a_r(title, font)
       end
     end
 
@@ -1897,12 +1900,12 @@ module Writexlsx
     #
     # Write the <a:r> element.
     #
-    def write_a_r(title) # :nodoc:
+    def write_a_r(title, font) # :nodoc:
       @writer.tag_elements('a:r') do
         # Write the a:rPr element.
-        write_a_r_pr(title.name_font)
+        write_a_r_pr(font)
         # Write the a:t element.
-        write_a_t(title.name)
+        write_a_t(title.respond_to?(:name) ? title.name : title)
       end
     end
 
@@ -1967,17 +1970,27 @@ module Writexlsx
       @writer.empty_tag('c:symbol', [ ['val', val] ])
     end
 
+    def has_fill_formatting(element)
+      line     = series_property(element, :line)
+      fill     = series_property(element, :fill)
+      pattern  = series_property(element, :pattern)
+      gradient = series_property(element, :gradient)
+
+      (line && ptrue?(line[:_defined])) ||
+        (fill && ptrue?(fill[:_defined])) || pattern || gradient
+    end
+
+
     #
     # Write the <c:spPr> element.
     #
     def write_sp_pr(series) # :nodoc:
-      line     = series.line
-      fill     = series.fill
-      pattern  = series.pattern  if series.respond_to?(:pattern)
-      gradient = series.gradient if series.respond_to?(:gradient)
+      return if !has_fill_formatting(series)
 
-      return if (!line || !ptrue?(line[:_defined])) &&
-        (!fill || !ptrue?(fill[:_defined])) && !pattern && !gradient
+      line     = series_property(series, :line)
+      fill     = series_property(series, :fill)
+      pattern  = series_property(series, :pattern)
+      gradient = series_property(series, :gradient)
 
       @writer.tag_elements('c:spPr') do
         # Write the fill elements for solid charts such as pie/doughnut and bar.
@@ -2002,6 +2015,14 @@ module Writexlsx
       end
     end
 
+    def series_property(object, property)
+      if object.respond_to?(property)
+        object.send(property)
+      elsif object.respond_to?(:[])
+        object[property]
+      end
+    end
+
     #
     # Write the <a:ln> element.
     #
@@ -2349,8 +2370,14 @@ module Writexlsx
       return unless labels
 
       @writer.tag_elements('c:dLbls') do
+        # Write the custom c:dLbl elements.
+        if labels[:custom]
+          write_custom_labels(labels, labels[:custom])
+        end
         # Write the c:numFmt element.
         write_data_label_number_format(labels[:num_format]) if labels[:num_format]
+        # Write the c:spPr element.
+        write_sp_pr(labels)
         # Write the data label font elements.
         write_axis_font(labels[:font]) if labels[:font]
         # Write the c:dLblPos element.
@@ -2372,6 +2399,105 @@ module Writexlsx
       end
     end
 
+    #
+    # Write the <c:dLbl> element.
+    #
+    def write_custom_labels(parent, labels)
+      index  = 0
+
+      labels.each do |label|
+        index += 1
+        next if !ptrue?(label)
+
+        @writer.tag_elements('c:dLbl') do
+          # Write the c:idx element.
+          write_idx(index - 1)
+
+          if label[:delete] && label[:delete]
+            write_delete(1)
+          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]
+          else
+            write_custom_label_format_only(label)
+          end
+        end
+      end
+    end
+
+    #
+    # Write parts of the <c:dLbl> element for strings.
+    #
+    def write_custom_label_str(label)
+      value          = label[:value]
+      font           = label[:font]
+      is_y_axis      = 0
+      has_formatting = has_fill_formatting(label)
+
+      # Write the c:layout element.
+      write_layout()
+
+      @writer.tag_elements('c:tx') do
+        # Write the c:rich element.
+        write_rich(value, font, is_y_axis, !has_formatting)
+      end
+
+      # Write the c:cpPr element.
+      write_sp_pr(label)
+    end
+
+    #
+    # Write parts of the <c:dLbl> element for formulas.
+    #
+    def write_custom_label_formula(label)
+      formula = label[:formula]
+      data_id = label[:data_id]
+
+      if data_id
+        data = @formula_data[data_id]
+      end
+
+      # Write the c:layout element.
+      write_layout
+
+      @writer.tag_elements('c:tx') do
+        # Write the c:strRef element.
+        write_str_ref(formula, data, 'str')
+      end
+
+      # Write the data label formatting, if any.
+      write_custom_label_format_only(label)
+    end
+
+    #
+    # Write parts of the <c:dLbl> element for labels where only the formatting has
+    # changed.
+    #
+    def write_custom_label_format_only(label)
+      font           = label[:font]
+      has_formatting = has_fill_formatting(label)
+
+      if has_formatting
+        # Write the c:spPr element.
+        write_sp_pr(label)
+        write_tx_pr(font)
+      elsif font
+        @writer.empty_tag('c:spPr')
+        write_tx_pr(font)
+      end
+    end
+
     #
     # Write the <c:showLegendKey> element.
     #
@@ -2700,7 +2826,7 @@ module Writexlsx
 
             # Write the a:srgbClr element.
             # TODO: Wait for a feature request to support transparency.
-            write_a_srgb_clr( color );
+            write_a_srgb_clr( color )
           end
         end
       end
@@ -2802,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/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
 

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.04.0"
+WriteXLSX_VERSION = "1.08.2"