write_xlsx 0.85.7 → 0.86.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9321ad366de31af18f34ce1898368f6d754759b9
-  data.tar.gz: 7ad3e41824e5e9443d211766fb285ca56550ff0b
+SHA256:
+  metadata.gz: 794b9b3028ff50abeab1e2c85d951fdc38526887ef6e2d64c6125afe697b4f92
+  data.tar.gz: 0a460f71a4cb05d4f72d7ad77308dbcda504b06f0e56ceceb7d0a9a6e0c0514f
 SHA512:
-  metadata.gz: 7aa745d393ba1664d8e59bcbf56c3eaf2430d4000dda9b4e929c6766bdf852ea1686af0fb0e30e7cec90fa94e49432ef0383aa871bec7c0ae45f13c4cc53f1ce
-  data.tar.gz: f321d7ddd751e9a4e757b75c519859be73cee90966f31ad1089e15cd8f2ce97b2f03a0d6abc89931d68862facd442000b88fc2177e421c488ed31d91db370aef
+  metadata.gz: b51f580ca37d7586f3faa6bafebeb76f2b14129070a0e7e70fe9d648e75e504983ad2ad97976ba49b3a8bb5af598826f54aa982dd73a7044132f32044bac6469
+  data.tar.gz: 661206fe8a1eeb9878329559ee9bf5f2a8f12db9515fba264368fe2f9df8711bffe4bb2457a51fb993dcb7aa74ce1c1fcd9740b6b05c6666edebae9288e2e66c

data/Changes

@@ -1,5 +1,34 @@
 Change history of write_xlsx rubygem.
 
+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
+
+2020-09-07 v0.85.9
+   apply pull-request #59 and #60
+
+2020-09-03 v0.85.8
+   apply pull-request #58 and #52
+
 2019-06-20 v0.85.7
    apply pull-request #26
 

data/README.md

@@ -84,7 +84,7 @@ 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)
+Converted to ruby by Hideo NAKAMURA(nakamrua.hideo@gmail.com)
 Copyright (c) 2012-2018 Hideo NAKAMURA.
 
 See LICENSE.txt for further details.

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

@@ -2631,7 +2631,7 @@ def write_custom_error_base(tag, values, data)
     end
 
     def write_num_ref_or_lit(values, data)
-      if values =~ /^=/                     # '=Sheet1!$A$1:$A$5'
+      if values.to_s =~ /^=/                     # '=Sheet1!$A$1:$A$5'
         write_num_ref(values, data, 'num')
       else                                  # [1, 2, 3]
         write_num_lit(values)

data/lib/write_xlsx/format.rb

@@ -287,11 +287,10 @@ def set_format_properties(*properties)   # :nodoc:
 
           # Create a sub to set the property.
           if value.respond_to?(:to_str) || !value.respond_to?(:+)
-            s = "set_#{key}('#{value}')"
+            send("set_#{key}", value.to_s)
           else
-            s = "set_#{key}(#{value})"
+            send("set_#{key}", value)
           end
-          eval s
         end
       end
     end
@@ -507,7 +506,7 @@ def self.color(color_code)
     def set_align(location)
       return unless location             # No default
 
-      location.downcase!
+      location = location.downcase
 
       set_text_h_align(1) if location == 'left'
       set_text_h_align(2) if location == 'centre'
@@ -583,7 +582,7 @@ def set_border_color(color)
     def set_rotation(rotation)
       if rotation == 270
         rotation = 255
-      elsif rotation >= -90 || rotation <= 90
+      elsif rotation >= -90 && rotation <= 90
         rotation = -rotation + 90 if rotation < 0
       else
         raise "Rotation #{rotation} outside range: -90 <= angle <= 90"

data/lib/write_xlsx/package/app.rb

@@ -32,6 +32,7 @@ def assemble_xml_file
             write_company
             write_links_up_to_date
             write_shared_doc
+            write_hyperlink_base
             write_hyperlinks_changed
             write_app_version
           end
@@ -220,6 +221,17 @@ def write_shared_doc
         @writer.data_element('SharedDoc', data)
       end
 
+      #
+      # Write the <HyperlinkBase> element.
+      #
+      def write_hyperlink_base
+        data = @properties[:hyperlink_base]
+
+        return unless data
+
+        @writer.data_element('HyperlinkBase', data)
+      end
+
       #
       # Write the <HyperlinksChanged> element.
       #

data/lib/write_xlsx/package/comments.rb

@@ -41,11 +41,13 @@ def initialize(workbook, worksheet, row, col, string, options = {})
       def backgrount_color(color)
         color_id = Format.color(color)
 
-        if color_id == 0
+        if color_id.to_s =~ /^#[0-9A-F]{6}/i
+          @color = color_id.to_s
+        elsif color_id == 0
           @color = '#ffffe1'
         else
           rgb = @workbook.palette[color_id - 8]
-          @color = "##{rgb_color(rgb)} [#{color_id}]\n"
+          @color = "##{rgb_color(rgb)} [#{color_id}]"
         end
       end
 

data/lib/write_xlsx/package/conditional_format.rb

@@ -71,6 +71,7 @@ def attributes
         attr << ['type' , type]
         attr << ['dxfId',    format]   if format
         attr << ['priority', priority]
+        attr << ['stopIfTrue', 1] if stop_if_true
         attr
       end
 
@@ -86,6 +87,10 @@ def priority
         @param[:priority]
       end
 
+      def stop_if_true
+        @param[:stop_if_true]
+      end
+
       def criteria
         @param[:criteria]
       end
@@ -306,7 +311,7 @@ def range_start_cell_for_conditional_formatting(*args)  # :nodoc:
 
       def row_col_param_for_conditional_formatting(*args)
         # Check for a cell reference in A1 notation and substitute row and column
-        if args[0] =~ /^\D/
+        if args[0].to_s =~ /^\D/
           # Check for a user defined multiple range like B3:K6,B8:K11.
           user_range = args[0].sub(/^=/, '').gsub(/\s*,\s*/, ' ').gsub(/\$/, '') if args[0] =~ /,/
         end
@@ -383,7 +388,7 @@ def check_conditional_formatting_parameters(param)  # :nodoc:
       end
 
       def convert_date_time_if_required(val)
-        if val =~ /T/
+        if val.to_s =~ /T/
           date_time = convert_date_time(val)
           raise "Invalid date/time value '#{val}' in conditional_formatting()" unless date_time
           date_time
@@ -401,6 +406,7 @@ def valid_parameter_for_conditional_formatting
          :value,
          :minimum,
          :maximum,
+         :stop_if_true,
          :min_type,
          :mid_type,
          :max_type,

data/lib/write_xlsx/package/shared_strings.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/utility'
 
@@ -8,11 +9,13 @@ class SharedStrings
 
       include Writexlsx::Utility
 
+      PRESERVE_SPACE_ATTRIBUTES = ['xml:space', 'preserve'].freeze
+
       def initialize
         @writer        = Package::XMLWriterSimple.new
         @strings       = [] # string table
         @strings_index = {} # string table index
-        @count         = {} # count
+        @count         = 0 # count
       end
 
       def index(string, params = {})
@@ -21,18 +24,18 @@ def index(string, params = {})
       end
 
       def add(string)
-        str = string.dup
-        if @count[str]
-          @count[str] += 1
-        else
+        unless @strings_index[string]
+          # Only first time the string will be append to list
+          # next time we only check and not #dup it
+          str = string.dup.freeze
           @strings << str
           @strings_index[str] = @strings.size - 1
-          @count[str] = 1
         end
+        @count += 1
       end
 
       def string(index)
-        @strings[index].dup
+        @strings[index]
       end
 
       def empty?
@@ -79,7 +82,6 @@ def write_sst_strings
       # Write the <si> element.
       #
       def write_si(string)
-        string = string.dup
         attributes = []
 
         # Excel escapes control characters with _xHHHH_ and also escapes any
@@ -102,7 +104,7 @@ def write_si(string)
         end
 
         # Add attribute to preserve leading or trailing whitespace.
-        attributes << ['xml:space', 'preserve'] if string =~ /\A\s|\s\Z/
+        attributes << PRESERVE_SPACE_ATTRIBUTES if string =~ /\A\s|\s\Z/
 
         # Write any rich strings without further tags.
         if string =~ %r{^<r>} && string =~ %r{</r>$}
@@ -122,7 +124,7 @@ def add_c2_c3(string)
       end
 
       def total_count
-        @count.values.inject(0) { |sum, count| sum += count }
+        @count
       end
 
       def unique_count