write_xlsx 0.86.0 → 0.87.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 794b9b3028ff50abeab1e2c85d951fdc38526887ef6e2d64c6125afe697b4f92
-  data.tar.gz: 0a460f71a4cb05d4f72d7ad77308dbcda504b06f0e56ceceb7d0a9a6e0c0514f
+  metadata.gz: 6e7cdfffc65c56b8de477d41c1126ebd46a7d6e63aee6d6660bab0e9283be2c6
+  data.tar.gz: c62748b94058a7021e796b88031b7d126b8508ce9ece50bdaa7455a620d8403b
 SHA512:
-  metadata.gz: b51f580ca37d7586f3faa6bafebeb76f2b14129070a0e7e70fe9d648e75e504983ad2ad97976ba49b3a8bb5af598826f54aa982dd73a7044132f32044bac6469
-  data.tar.gz: 661206fe8a1eeb9878329559ee9bf5f2a8f12db9515fba264368fe2f9df8711bffe4bb2457a51fb993dcb7aa74ce1c1fcd9740b6b05c6666edebae9288e2e66c
+  metadata.gz: 0042aea94458add0013ceefed1e734593692c00f9dc32d8b02fef80093b2e62d3510ef62e84481c74acbf0436e8fe8223485a562a76ec8fd011724e2869c5b1e
+  data.tar.gz: 0bb9fed1ec24707d52b7557c256579606c39eadb716bfdc4acb5e5e6b13f0792fb3627e75f16aef375675160d57556fff7f02af6fea8e4819bbdb244f96657e9

data/Changes

@@ -1,5 +1,18 @@
 Change history of write_xlsx rubygem.
 
+2020-12-26 v0.87.0
+
+   Added chart pattern and gradient fills.
+
+   Added option to set chart tick interval.
+
+   Add checks for valid and non-duplicate worksheet table names.
+
+   Added support for table header formatting and a fix for wrapped lines in
+   the header.
+
+   use minitest instead of test-unit
+
 2020-11-01 v0.86.0
    Fix for images with negative offsets.
 

data/README.md

@@ -5,11 +5,11 @@
 
 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-0.84](https://github.com/jmcnamara/excel-writer-xlsx) .
+[Excel::Writer::XLSX-0.86](https://github.com/jmcnamara/excel-writer-xlsx) .
 
 ## Description
 
-Reference doc : http://cxn03651.github.io/write_xlsx/
+Reference doc : https://cxn03651.github.io/write_xlsx/
 
 The WriteXLSX supports the following features:
 * Multiple worksheets
@@ -85,13 +85,13 @@ the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
 Original Perl module was written by John McNamara(jmcnamara@cpan.org).
 
 Converted to ruby by Hideo NAKAMURA(nakamrua.hideo@gmail.com)
-Copyright (c) 2012-2018 Hideo NAKAMURA.
+Copyright (c) 2012-2020 Hideo NAKAMURA.
 
 See LICENSE.txt for further details.
 
 ## Contributing to write_xlsx
 
-* repsitory: http://github.com/cxn03651/write_xlsx
+* repsitory: https://github.com/cxn03651/write_xlsx
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project

data/examples/chart_combined.rb

@@ -99,7 +99,9 @@
 column_chart2.set_title(:name => 'Combine chart - secondary Y axis')
 column_chart2.set_x_axis(:name => 'Test number')
 column_chart2.set_y_axis(:name => 'Sample length (mm)')
-column_chart2.set_y2_axis(:name => 'Target length (mm)')
+
+# Note: the y2 properties are on the secondary chart.
+line_chart2.set_y_axis(:name => 'Target length (mm)')
 
 # Insert the chart into the worksheet
 worksheet.insert_chart('E18', column_chart2)

data/lib/write_xlsx/chart.rb

@@ -40,7 +40,7 @@ class ChartArea
     include Writexlsx::Utility
     include Writexlsx::Gradient
 
-    attr_reader :line, :fill, :gradient, :layout
+    attr_reader :line, :fill, :pattern, :gradient, :layout
 
     def initialize(params = {})
       @layout = layout_properties(params[:layout])
@@ -51,6 +51,9 @@ def initialize(params = {})
       # Set the line properties for the chartarea.
       @line = border ? line_properties(border) : line_properties(params[:line])
 
+      # Set the pattern properties for the series.
+      @pattern = pattern_properties(params[:pattern])
+
       # Set the gradient fill properties for the series.
       @gradient = gradient_properties(params[:gradient])
 
@@ -58,9 +61,16 @@ def initialize(params = {})
       fill = params[:color] ? { :color => params[:color] } : params[:fill]
       @fill = fill_properties(fill)
 
-      if ptrue?(@gradient)
+      # Pattern fill overrides solid fill.
+      if ptrue?(@pattern)
         @fill = nil
       end
+
+      # Gradient fill overrides solid and pattern fills.
+      if ptrue?(@gradient)
+        @pattern = nil
+        @fill    = nil
+      end
     end
 
     private
@@ -1298,6 +1308,8 @@ def write_cat_axis(params) # :nodoc:
         write_label_offset(100)
         # Write the c:tickLblSkip element.
         write_tick_lbl_skip(x_axis.interval_unit)
+        # Write the c:tickMarkSkip element.
+        write_tick_mark_skip(x_axis.interval_tick)
       end
     end
 
@@ -1436,6 +1448,8 @@ def write_date_axis(params)  # :nodoc:
         write_label_offset(100)
         # Write the c:tickLblSkip element.
         write_tick_lbl_skip(x_axis.interval_unit)
+        # Write the c:tickMarkSkip element.
+        write_tick_mark_skip(x_axis.interval_tick)
         # Write the c:majorUnit element.
         write_c_major_unit(x_axis.major_unit)
         # Write the c:majorTimeUnit element.
@@ -1630,6 +1644,15 @@ def write_tick_lbl_skip(val) # :nodoc:
       @writer.empty_tag('c:tickLblSkip', [ ['val', val] ])
     end
 
+    #
+    # Write the <c:tickMarkSkip> element.
+    #
+    def write_tick_mark_skip(val)  # :nodoc:
+      return unless val
+
+      @writer.empty_tag( 'c:tickMarkSkip', [ ['val', val] ])
+    end
+
     #
     # Write the <c:majorGridlines> element.
     #
@@ -2090,10 +2113,11 @@ def write_symbol(val) # :nodoc:
     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 (!line || !ptrue?(line[:_defined])) &&
-        (!fill || !ptrue?(fill[:_defined])) && !gradient
+        (!fill || !ptrue?(fill[:_defined])) && !pattern && !gradient
 
       @writer.tag_elements('c:spPr') do
         # Write the fill elements for solid charts such as pie/doughnut and bar.
@@ -2106,6 +2130,9 @@ def write_sp_pr(series) # :nodoc:
             write_a_solid_fill(fill)
           end
         end
+        if ptrue?(pattern)
+          write_a_patt_fill(pattern)
+        end
         if ptrue?(gradient)
           # Write the a:gradFill element.
           write_a_grad_fill(gradient)
@@ -2829,6 +2856,26 @@ def write_a_tile_rect(type)
       @writer.empty_tag('a:tileRect', attributes)
     end
 
+    #
+    # Write the <a:pattFill> element.
+    #
+    def write_a_patt_fill(pattern)
+      attributes = [ ['prst', pattern[:pattern]] ]
+
+      @writer.tag_elements('a:pattFill', attributes) do
+        write_a_fg_clr(pattern[:fg_color])
+        write_a_bg_clr(pattern[:bg_color])
+      end
+    end
+
+    def write_a_fg_clr(color)
+      @writer.tag_elements('a:fgClr') { write_a_srgb_clr(color(color)) }
+    end
+
+    def write_a_bg_clr(color)
+      @writer.tag_elements('a:bgClr') { write_a_srgb_clr(color(color)) }
+    end
+
     def write_bars_base(tag, format)
       if format.line_defined? || format.fill_defined?
         @writer.tag_elements(tag) { write_sp_pr(format) }

data/lib/write_xlsx/chart/axis.rb

@@ -14,7 +14,7 @@ class Axis < Caption
       attr_reader :display_units_visible, :display_units
       attr_reader :log_base, :crossing, :position_axis, :label_position, :visible
       attr_reader :num_format_linked, :num_font, :layout, :interval_unit
-      attr_reader :major_gridlines, :minor_gridlines, :reverse
+      attr_reader :interval_tick, :major_gridlines, :minor_gridlines, :reverse
       attr_reader :line, :fill, :text_axis
       #
       # Convert user defined axis values into axis instance.
@@ -27,7 +27,7 @@ def merge_with_hash(params) # :nodoc:
           :reverse, :min, :max, :minor_unit, :major_unit, :minor_unit_type,
           :major_unit_type, :log_base, :crossing, :position_axis,
           :label_position, :num_format, :num_format_linked, :interval_unit,
-          :major_tick_mark, :line, :fill
+          :interval_tick, :major_tick_mark, :line, :fill
         ].each { |val| instance_variable_set("@#{val}", args[val]) }
         @visible           = args[:visible] || 1
 

data/lib/write_xlsx/chart/series.rb

@@ -8,22 +8,30 @@ class Chartline
       include Writexlsx::Utility
       include Writexlsx::Gradient
 
-      attr_reader :line, :fill, :type
+      attr_reader :line, :fill, :type, :gradient, :pattern
 
       def initialize(params)
         @line      = params[:line]
         @fill      = params[:fill]
+        @pattern   = params[:pattern]
+        @gradient  = params[:gradient]
         # Set the line properties for the marker..
         @line = line_properties(@line)
         # Allow 'border' as a synonym for 'line'.
         @line = line_properties(params[:border]) if params[:border]
-
-        # Set the gradient fill properties for the series.
-        @gradient = gradient_properties(params[:gradient])
-
         # Set the fill properties for the marker.
         @fill = fill_properties(@fill)
+        # Set the pattern properties for the series.
+        @pattern = pattern_properties(@pattern)
+        # Set the gradient fill properties for the series.
+        @gradient = gradient_properties(@gradient)
+        # Pattern fill overrides solid fill.
         @fill = nil if ptrue?(@gradient)
+        # Gradient fill overrides solid and pattern fills.
+        if ptrue?(@gradient)
+          @pattern = nil
+          @fill    = nil
+        end
       end
 
       def line_defined?
@@ -170,7 +178,7 @@ class Series
       include Writexlsx::Gradient
 
       attr_reader :values, :categories, :name, :name_formula, :name_id
-      attr_reader :cat_data_id, :val_data_id, :fill, :gradient
+      attr_reader :cat_data_id, :val_data_id, :fill, :pattern, :gradient
       attr_reader :trendline, :smooth, :labels, :invert_if_negative
       attr_reader :x2_axis, :y2_axis, :error_bars, :points
       attr_accessor :line, :marker
@@ -184,13 +192,21 @@ def initialize(chart, params = {})
 
         set_data_ids(params)
 
-        @line = line_properties(params[:border] || params[:line])
-        @fill = fill_properties(params[:fill])
-
+        @line       = line_properties(params[:border] || params[:line])
+        @fill       = fill_properties(params[:fill])
+        @pattern    = pattern_properties(params[:pattern])
         @gradient   = gradient_properties(params[:gradient])
-        @fill       = nil if ptrue?(@gradient)
+        # Pattern fill overrides solid fill.
+        @fill       = nil if ptrue?(@pattern)
+        # Gradient fill overrides solid and patter fills.
+        if ptrue?(@gradient)
+          @pattern = nil
+          @fill    = nil
+        end
 
+        # Set the marker properties for the series.
         @marker     = Marker.new(params[:marker]) if params[:marker]
+        # Set the trendline properties for the series.
         @trendline  = Trendline.new(params[:trendline]) if params[:trendline]
         @error_bars = errorbars(params[:x_error_bars], params[:y_error_bars])
         @points     = params[:points].collect { |p| p ? Point.new(p) : p } if params[:points]

data/lib/write_xlsx/format.rb

@@ -844,6 +844,10 @@ def write_font_family_scheme(writer)
           writer.empty_tag('family', [ ['val', @font_family] ])
       end
 
+      if ptrue?(@font_charset)
+        writer.empty_tag('charset', [ ['val', @font_charset] ])
+      end
+
       if @font == 'Calibri' && !ptrue?(@hyperlink)
         writer.empty_tag('scheme', [ ['val', @font_scheme] ])
       end

data/lib/write_xlsx/package/table.rb

@@ -277,8 +277,22 @@ def set_the_table_style
       def set_the_table_name
         if @param[:name]
           name = @param[:name]
+
+          # Raise if the name contains invalid chars as defined by Excel help.
+          if name !~ /^[\w\\][\w\\.]*$/ || name =~ /^\d/
+            raise "Invalid character in name '#{name} used in add_table()"
+          end
+
+          # Raise if the name looks like a cell name.
+          if name =~ /^[a-zA-Z][a-zA-Z]?[a-dA-D]?[0-9]+$/
+            ralse "Invalid name '#{name}' looks like a cell name in add_table()"
+          end
+
+          # Raise if the name looks like a R1C1.
+          if name =~ /^[rcRC]$/ || name =~ /^[rcRC]\d+[rcRC]\d+$/
+            raise "Invalid name '#{name}' like a RC cell ref in add_table()"
+          end          
           
-          raise "Name '#{name} in add_table cannot contain spaces" if name =~ /\s/
           @name = @param[:name]
         end
       end

data/lib/write_xlsx/utility.rb

@@ -543,6 +543,91 @@ def fill_properties(fill) # :nodoc:
       line_fill_properties(fill)
     end
 
+    #
+    # Convert user defined pattern properties to the structure required internally.
+    #
+    def pattern_properties(args) # :nodoc:
+      pattern = {}
+
+      return nil unless args
+
+      # Check the pattern type is present.
+      return nil unless args.has_key?(:pattern)
+
+      # Check the foreground color is present.
+      retuen nil unless args.has_key?(:fg_color)
+
+      types = {
+        'percent_5'                 => 'pct5',
+        'percent_10'                => 'pct10',
+        'percent_20'                => 'pct20',
+        'percent_25'                => 'pct25',
+        'percent_30'                => 'pct30',
+        'percent_40'                => 'pct40',
+
+        'percent_50'                => 'pct50',
+        'percent_60'                => 'pct60',
+        'percent_70'                => 'pct70',
+        'percent_75'                => 'pct75',
+        'percent_80'                => 'pct80',
+        'percent_90'                => 'pct90',
+
+        'light_downward_diagonal'   => 'ltDnDiag',
+        'light_upward_diagonal'     => 'ltUpDiag',
+        'dark_downward_diagonal'    => 'dkDnDiag',
+        'dark_upward_diagonal'      => 'dkUpDiag',
+        'wide_downward_diagonal'    => 'wdDnDiag',
+        'wide_upward_diagonal'      => 'wdUpDiag',
+
+        'light_vertical'            => 'ltVert',
+        'light_horizontal'          => 'ltHorz',
+        'narrow_vertical'           => 'narVert',
+        'narrow_horizontal'         => 'narHorz',
+        'dark_vertical'             => 'dkVert',
+        'dark_horizontal'           => 'dkHorz',
+
+        'dashed_downward_diagonal'  => 'dashDnDiag',
+        'dashed_upward_diagonal'    => 'dashUpDiag',
+        'dashed_horizontal'         => 'dashHorz',
+        'dashed_vertical'           => 'dashVert',
+        'small_confetti'            => 'smConfetti',
+        'large_confetti'            => 'lgConfetti',
+
+        'zigzag'                    => 'zigZag',
+        'wave'                      => 'wave',
+        'diagonal_brick'            => 'diagBrick',
+        'horizontal_brick'          => 'horzBrick',
+        'weave'                     => 'weave',
+        'plaid'                     => 'plaid',
+
+        'divot'                     => 'divot',
+        'dotted_grid'               => 'dotGrid',
+        'dotted_diamond'            => 'dotDmnd',
+        'shingle'                   => 'shingle',
+        'trellis'                   => 'trellis',
+        'sphere'                    => 'sphere',
+
+        'small_grid'                => 'smGrid',
+        'large_grid'                => 'lgGrid',
+        'small_check'               => 'smCheck',
+        'large_check'               => 'lgCheck',
+        'outlined_diamond'          => 'openDmnd',
+        'solid_diamond'             => 'solidDmnd'        
+      }
+
+      # Check for valid types.
+      if types[args[:pattern]]
+        pattern[:pattern] = types[args[:pattern]]
+      else
+        raise "Unknown pattern type '#{args[:pattern]}'"
+      end
+
+      pattern[:bg_color] = args[:bg_color] || '#FFFFFF'
+      pattern[:fg_color] = args[:fg_color]
+
+      pattern
+    end
+    
     def line_fill_properties(params)
       return { :_defined => 0 } unless params
       ret = params.dup

data/lib/write_xlsx/version.rb

@@ -1 +1 @@
-WriteXLSX_VERSION = "0.86.0"
+WriteXLSX_VERSION = "0.87.0"

data/lib/write_xlsx/workbook.rb

@@ -726,7 +726,7 @@ def define_name(name, formula)
 
       # Raise if the sheet index wasn't found.
       if !sheet_index
-       raise "Unknown sheet name #{sheetname} in defined_name()\n"
+       raise "Unknown sheet name #{sheetname} in defined_name()"
       end
 
       # Raise if the name contains invalid chars as defined by Excel help.
@@ -734,17 +734,17 @@ def define_name(name, formula)
       # http://office.microsoft.com/en-001/excel-help/define-and-use-names-in-formulas-HA010147120.aspx#BMsyntax_rules_for_names
       #
       if name =~ /\A[-0-9 !"#\$%&'\(\)\*\+,\.:;<=>\?@\[\]\^`\{\}~]/ || name =~ /.+[- !"#\$%&'\(\)\*\+,\\:;<=>\?@\[\]\^`\{\}~]/
-        raise "Invalid characters in name '#{name}' used in defined_name()\n"
+        raise "Invalid characters in name '#{name}' used in defined_name()"
       end
 
       # Raise if the name looks like a cell name.
       if name =~ %r(^[a-zA-Z][a-zA-Z]?[a-dA-D]?[0-9]+$)
-        raise "Invalid name '#{name}' looks like a cell name in defined_name()\n"
+        raise "Invalid name '#{name}' looks like a cell name in defined_name()"
       end
 
       # Raise if the name looks like a R1C1
       if name =~ /\A[rcRC]\Z/ || name =~ /\A[rcRC]\d+[rcRC]\d+\Z/
-        raise "Invalid name '#{name}' like a RC cell ref in defined_name()\n"
+        raise "Invalid name '#{name}' like a RC cell ref in defined_name()"
       end
 
       @defined_names.push([ name, sheet_index, formula.sub(/^=/, '') ])
@@ -1633,9 +1633,10 @@ def prepare_vml_objects  #:nodoc:
     #
     def prepare_tables
       table_id = 0
+      seen     = {}
 
       sheets.each do |sheet|
-        table_id += sheet.prepare_tables(table_id + 1)
+        table_id += sheet.prepare_tables(table_id + 1, seen)
       end
     end