write_xlsx 0.85.10 → 0.89.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46ee9d7976dffd23442ab3dc1c87eb79d11786b5c6c9747f805a018a22330698
-  data.tar.gz: 43c1478b3d812cc7ba3d3d616b9fe9c14ef58b0e63c565d3d90378cdad6cdb92
+  metadata.gz: 980d940d4b7386abe4429d994fdb89621a410b7dee208f931e0571034c40b7df
+  data.tar.gz: 376c1bd91e9d4139af09b69a35509125566a3a44a072f91e27cfd38524f579ae
 SHA512:
-  metadata.gz: 626c6f160305d4a67487c10174d45daf37cd7e9eef9736f5d6adbf44219e0aa996f52dc07564b3124141cc94d3d286acf9631176b913cf91e733de8ef0fda16d
-  data.tar.gz: a1d8170e68cbd7ee0f06a5b9ea00aa801bf990a6a06090ce0abe275bd84bd8c1201740e30735b887761a57e0d28357431e6a3d5a5e17a995b6fe2d5ff2c7a43a
+  metadata.gz: 2be6712f3085f77b124f8ce6a400acf9a9c3edea9e27bcefcdef0926af29b29f2cb31eb3b82f5291bf1a6294afd4c504a1e2f32602f7fbbd1aeacc54d79fb9a2
+  data.tar.gz: 15cf003eb84c5312b01f4890e8be4299faf88f92710706f3c01a98c28ad35fb9ec1fbbcab253724804e1b4bfdcfa7c4cf0378d8304685f49c60bfa30651737b0

data/.travis.yml

@@ -1,7 +1,50 @@
 language: ruby
 rvm:
+- 3.0.0
+- 2.7.2
+- 2.7.1
+- 2.7.0
+- 2.6.6
+- 2.6.5
+- 2.6.4
+- 2.6.3
+- 2.6.2
+- 2.6.1
+- 2.6.0
+- 2.5.8
+- 2.5.7
+- 2.5.6
+- 2.5.5
+- 2.5.4
+- 2.5.3
+- 2.5.2
+- 2.5.1
+- 2.5.0
+- 2.4.10
+- 2.4.9
+- 2.4.8
+- 2.4.7
+- 2.4.6
+- 2.4.5
+- 2.4.4
+- 2.4.3
+- 2.4.2
+- 2.4.1
+- 2.4.0
+- 2.3.8
+- 2.3.7
+- 2.3.6
+- 2.3.5
+- 2.3.4
+- 2.3.3
+- 2.3.2
 - 2.3.1
 - 2.3.0
+- 2.2.10
+- 2.2.9
+- 2.2.8
+- 2.2.7
+- 2.2.6
 - 2.2.5
 - 2.2.4
 - 2.2.3

data/Changes

@@ -1,5 +1,49 @@
 Change history of write_xlsx rubygem.
 
+2020-12-27 v0.89.0
+
+   Added write_boolean() worksheet method to write Excel boolean values.
+
+
+2020-12-26 v0.88.0
+
+   Added transparency option to solid fills in chart areas.
+
+   Added options to configure chart axis tick placement.
+
+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.
+
+   Allow hyperlinks longer than 255 characters when the link and anchor
+   are each less than or equal to 255 characters.
+
+   Added hyperlink_base document property.
+
+   Added option to allow data validation input messages with the ‘any’
+   validate parameter.
+
+   Added "stop if true" feature to conditional formatting.
+
+   Added better support and documentation for html colours throughout
+   the module. The use of the Excel97 colour palette is supported for
+   backward compatibility but deprecated.
+
+2020-10-23 v0.85.11
+   Added Worksheet#update_range_format_with_params
+
 2020-10-23 v0.85.10
    Fix frozen string litterals problems in Format#set_align
 

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2014 Hideo NAKAMURA
+Copyright (c) 2012-2020 Hideo NAKAMURA
 
 MIT License
 

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.89](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
@@ -84,14 +84,14 @@ the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
 ## Copyright
 Original Perl module was written by John McNamara(jmcnamara@cpan.org).
 
-Converted to ruby by Hideo NAKAMURA(cxn03651@msj.biglobe.ne.jp)
-Copyright (c) 2012-2018 Hideo NAKAMURA.
+Converted to ruby by Hideo NAKAMURA(nakamrua.hideo@gmail.com)
+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/examples/colors.rb

@@ -126,4 +126,51 @@
   end
 end
 
+
+#
+# Demonstrate the Html colors.
+#
+
+colors = {
+  '#000000' => 'black',
+  '#0000FF' => 'blue',
+  '#800000' => 'brown',
+  '#00FFFF' => 'cyan',
+  '#808080' => 'gray',
+  '#008000' => 'green',
+  '#00FF00' => 'lime',
+  '#FF00FF' => 'magenta',
+  '#000080' => 'navy',
+  '#FF6600' => 'orange',
+  '#FF00FF' => 'pink',
+  '#800080' => 'purple',
+  '#FF0000' => 'red',
+  '#C0C0C0' => 'silver',
+  '#FFFFFF' => 'white',
+  '#FFFF00' => 'yellow'
+}
+
+worksheet3 = workbook.add_worksheet('Html colors')
+
+worksheet3.set_column(0, 3, 15)
+
+worksheet3.write(0, 0, "Html",  heading)
+worksheet3.write(0, 1, "Name",  heading)
+worksheet3.write(0, 2, "Color", heading)
+
+i = 1
+
+colors.each do |html_color, color|
+  format = workbook.add_format(
+    :fg_color => html_color,
+    :pattern  => 1,
+    :border   => 1
+  )
+  
+  worksheet3.write(i + 1, 1, html_color, center)
+  worksheet3.write(i + 1, 2, color,      center)
+  worksheet3.write(i + 1, 3, '',         format)
+  i += 1
+end
+
 workbook.close

data/examples/comments2.rb

@@ -247,7 +247,7 @@
 comment = 'Hello.'
 
 worksheet6.write( 'C9', cell_text, text_wrap )
-worksheet6.write_comment( 'C9', comment, :color => 0x35 )
+worksheet6.write_comment( 'C9', comment, :color => '#FF6600' )
 
 
 ###############################################################################

data/examples/conditional_format.rb

@@ -12,6 +12,7 @@
 worksheet6 = workbook.add_worksheet
 worksheet7 = workbook.add_worksheet
 worksheet8 = workbook.add_worksheet
+worksheet9 = workbook.add_worksheet
 
 # Light red fill with dark red text.
 format1 = workbook.add_format(
@@ -25,6 +26,12 @@
     :color    => '#006100'
 )
 
+# Blue fill with dark blue text.
+format3 = workbook.add_format(
+    :bg_color => '#C6CEFF',
+    :color    => '#0000FF'
+)
+
 # Some sample data to run the conditional formatting against.
 data = [
     [ 34, 72,  38, 30, 75, 48, 75, 66, 84, 86 ],
@@ -219,18 +226,19 @@
 #
 caption = 'Examples of color scales and data bars. Default colors.'
 
-data = 1 .. 12
+# Use different sample data for examples 7 and 8
+data7 = 1 .. 12
 
 worksheet7.write('A1', caption)
 
 worksheet7.write('B2', "2 Color Scale")
-worksheet7.write_col('B3', data)
+worksheet7.write_col('B3', data7)
 
 worksheet7.write('D2', "3 Color Scale")
-worksheet7.write_col('D3', data)
+worksheet7.write_col('D3', data7)
 
 worksheet7.write('F2', "Data Bars")
-worksheet7.write_col('F3', data)
+worksheet7.write_col('F3', data7)
 
 
 worksheet7.conditional_formatting('B3:B14',
@@ -258,18 +266,16 @@
 #
 caption = 'Examples of color scales and data bars. Modified colors.'
 
-data = 1 .. 12
-
 worksheet8.write('A1', caption)
 
 worksheet8.write('B2', "2 Color Scale")
-worksheet8.write_col('B3', data)
+worksheet8.write_col('B3', data7)
 
 worksheet8.write('D2', "3 Color Scale")
-worksheet8.write_col('D3', data)
+worksheet8.write_col('D3', data7)
 
 worksheet8.write('F2', "Data Bars")
-worksheet8.write_col('F3', data)
+worksheet8.write_col('F3', data7)
 
 
 worksheet8.conditional_formatting('B3:B14',
@@ -296,4 +302,49 @@
     }
 )
 
+###############################################################################
+#
+# Example 9
+#
+caption = 'Cells with values >= 100 are always in blue. ' +
+  'Otherwise, cells with values >= 50 are in light red ' +
+  'and values < 50 are in light green.'
+
+# Write the data.
+worksheet9.write('A1', caption)
+worksheet9.write_col('B3', data)
+
+# Write a conditional format over a range.
+# Use stopIfTrue to prevent previous formats from being used
+# if the conditions of this format are met.
+worksheet9.conditional_formatting('B3:K12',
+    {
+        :type         => 'cell',
+        :criteria     => '>=',
+        :value        => 100,
+        :format       => format3,
+        :stop_if_true => 1
+    }
+)
+
+# Write another conditional format over the same range.
+worksheet9.conditional_formatting('B3:K12',
+    {
+        :type     => 'cell',
+        :criteria => '>=',
+        :value    => 50,
+        :format   => format1
+    }
+)
+
+# Write another conditional format over the same range.
+worksheet9.conditional_formatting('B3:K12',
+    {
+        :type     => 'cell',
+        :criteria => '<',
+        :value    => 50,
+        :format   => format2
+    }
+)
+
 workbook.close

data/examples/data_validate.rb

@@ -19,13 +19,13 @@
 
 # Add a format for the header cells.
 header_format = workbook.add_format(
-                                            :border      => 1,
-                                            :bg_color    => 43,
-                                            :bold        => 1,
-                                            :text_wrap   => 1,
-                                            :valign      => 'vcenter',
-                                            :indent      => 1
-                                         )
+  :border      => 1,
+  :bg_color    => '#C6EFCE',
+  :bold        => 1,
+  :text_wrap   => 1,
+  :valign      => 'vcenter',
+  :indent      => 1
+)
 
 # Set up layout of the worksheet.
 worksheet.set_column('A:A', 68)

data/examples/panes.rb

@@ -39,7 +39,7 @@
 header = workbook.add_format(
                              :align    => 'center',
                              :valign   => 'vcenter',
-                             :fg_color => 0x2A
+                             :fg_color => '#C3FFC0'
                              )
 
 center = workbook.add_format(:align => 'center')

data/examples/tab_colors.rb

@@ -20,6 +20,6 @@
 # Worksheet1 will have the default tab colour.
 worksheet2.tab_color = 'red'
 worksheet3.tab_color = 'green'
-worksheet4.tab_color = 0x35    # Orange
+worksheet4.tab_color = '#FF6600'    # Orange
 
 workbook.close

data/examples/update_range_format_with_params.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# A simple example of how to use the write_xlsx gem to
+# update format of the range of cells.
+#
+
+require 'write_xlsx'
+
+workbook = WriteXLSX.new('update_range_format_with_params.xlsx')
+worksheet = workbook.add_worksheet
+
+common_format = workbook.add_format(align: 'center', border: 1)
+
+table_contents = [
+  ['Table', 'Header', 'Contents'],
+  ['table', 'body', 'contents'],
+  ['table', 'body', 'contents'],
+  ['table', 'body', 'contents']
+]
+
+worksheet.write_col(0, 0, table_contents, common_format)
+worksheet.update_range_format_with_params(
+  0, 0, 0, 2,
+  bold: 1, top: 2, bottom: 2, bg_color: 31
+)
+worksheet.update_range_format_with_params(0, 0, 3, 0, left: 2)
+worksheet.update_range_format_with_params(0, 2, 3, 2, right: 2)
+worksheet.update_range_format_with_params(3, 0, 3, 2, bottom: 2)
+
+workbook.close

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
@@ -1275,6 +1285,9 @@ def write_cat_axis(params) # :nodoc:
         # Write the c:majorTickMark element.
         write_major_tick_mark(x_axis.major_tick_mark)
 
+        # Write the c:minorTickMark element.
+        write_minor_tick_mark(x_axis.minor_tick_mark)
+
         # Write the c:tickLblPos element.
         write_tick_label_pos(x_axis.label_position)
 
@@ -1298,6 +1311,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
 
@@ -1347,6 +1362,9 @@ def write_val_axis_base(x_axis, y_axis, axis_ids_0, axis_ids_1, position)  # :no
         # Write the c:majorTickMark element.
         write_major_tick_mark(y_axis.major_tick_mark)
 
+        # Write the c:minorTickMark element.
+        write_minor_tick_mark(y_axis.minor_tick_mark)
+
         # Write the c:tickLblPos element.
         write_tick_label_pos(y_axis.label_position)
 
@@ -1436,6 +1454,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.
@@ -1567,6 +1587,15 @@ def write_major_tick_mark(val)
       @writer.empty_tag('c:majorTickMark', [ ['val', val] ])
     end
 
+    #
+    # Write the <c:minorTickMark> element.
+    #
+    def write_minor_tick_mark(val)
+      return unless ptrue?(val)
+
+      @writer.empty_tag('c:minorTickMark', [ ['val', val] ])
+    end
+
     #
     # Write the <c:tickLblPos> element.
     #
@@ -1630,6 +1659,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 +2128,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 +2145,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)
@@ -2160,18 +2202,38 @@ def write_a_no_fill # :nodoc:
     #
     # Write the <a:solidFill> element.
     #
-    def write_a_solid_fill(line) # :nodoc:
+    def write_a_solid_fill(fill) # :nodoc:
       @writer.tag_elements('a:solidFill') do
-        # Write the a:srgbClr element.
-        write_a_srgb_clr(color(line[:color])) if line[:color]
+        if fill[:color]
+          # Write the a:srgbClr element.
+          write_a_srgb_clr(color(fill[:color]), fill[:transparency])
+        end
       end
     end
 
     #
     # Write the <a:srgbClr> element.
     #
-    def write_a_srgb_clr(val) # :nodoc:
-      @writer.empty_tag('a:srgbClr', [ ['val', val] ])
+    def write_a_srgb_clr(color, transparency = nil) # :nodoc:
+      tag        = 'a:srgbClr'
+      attributes = [ ['val', color] ]
+
+      if ptrue?(transparency)
+        @writer.tag_elements(tag, attributes) do
+          write_a_alpha(transparency)
+        end
+      else
+        @writer.empty_tag(tag, attributes)
+      end
+     end
+
+    #
+    # Write the <a:alpha> element.
+    #
+    def write_a_alpha(val)
+      val = (100 - val.to_i) * 1000
+
+      @writer.empty_tag('a:alpha', [ ['val', val] ])
     end
 
     #
@@ -2829,6 +2891,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) }