write_xlsx 0.85.11 → 0.86.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89f382bd2df994369316a0422365541984f53ec084c5d3bb1c5d5a03523757a9
-  data.tar.gz: 363697c51b2250602fd5122aa3e9c7a6c71ec755a671e659f08f19c58b184792
+  metadata.gz: 794b9b3028ff50abeab1e2c85d951fdc38526887ef6e2d64c6125afe697b4f92
+  data.tar.gz: 0a460f71a4cb05d4f72d7ad77308dbcda504b06f0e56ceceb7d0a9a6e0c0514f
 SHA512:
-  metadata.gz: c719aa61decdc25064a72704d015d8a1eea48b3a94ccb7ccaf01e99456a6521c5c4fc5a5ee738a721c1e06c4632c737cf47d14afd3830a164162a789acc6e452
-  data.tar.gz: 96f55161f36511ef22708a377ea647f21f4ae76c978039b0c85c32c5db55ac0330f3e4c7a0e1f030d60c3d00c0c96f6c3f045bbfd240a2e2031c8ced2b2c2945
+  metadata.gz: b51f580ca37d7586f3faa6bafebeb76f2b14129070a0e7e70fe9d648e75e504983ad2ad97976ba49b3a8bb5af598826f54aa982dd73a7044132f32044bac6469
+  data.tar.gz: 661206fe8a1eeb9878329559ee9bf5f2a8f12db9515fba264368fe2f9df8711bffe4bb2457a51fb993dcb7aa74ce1c1fcd9740b6b05c6666edebae9288e2e66c

data/Changes

@@ -1,5 +1,22 @@
 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
 

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

@@ -582,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
@@ -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/table.rb

@@ -10,7 +10,7 @@ class Table
 
       class ColumnData
         attr_reader :id
-        attr_accessor :name, :format, :formula
+        attr_accessor :name, :format, :formula, :name_format
         attr_accessor :total_string, :total_function
 
         def initialize(id, param = {})
@@ -20,6 +20,7 @@ def initialize(id, param = {})
           @total_function = ''
           @formula        = ''
           @format         = nil
+          @name_format    = nil
           @user_data      = param[id-1] if param
         end
       end
@@ -93,10 +94,14 @@ def overrite_the_defaults_with_any_use_defined_values(col_id, col_data, col_num)
             if user_data[:header] && !user_data[:header].empty?
               col_data.name = user_data[:header]
             end
+
+            # Get the header format if defined.
+            col_data.name_format = user_data[:header_format]
+            
             # Handle the column formula.
             handle_the_column_formula(
-                                      col_data, col_num, user_data[:formula], user_data[:format]
-                                      )
+              col_data, col_num, user_data[:formula], user_data[:format]
+            )
 
             # Handle the function for the total row.
             if user_data[:total_function]
@@ -123,7 +128,9 @@ def overrite_the_defaults_with_any_use_defined_values(col_id, col_data, col_num)
 
       def write_the_column_headers_to_the_worksheet(col_num, col_data)
         if @param[:header_row] != 0
-          @worksheet.write_string(@row1, col_num, col_data.name)
+          @worksheet.write_string(
+            @row1, col_num, col_data.name, col_data.name_format
+          )
         end
       end
 
@@ -268,7 +275,12 @@ def set_the_table_style
       end
 
       def set_the_table_name
-        @name = @param[:name] if @param[:name]
+        if @param[:name]
+          name = @param[:name]
+          
+          raise "Name '#{name} in add_table cannot contain spaces" if name =~ /\s/
+          @name = @param[:name]
+        end
       end
 
       def set_the_table_and_autofilter_ranges

data/lib/write_xlsx/package/xml_writer_simple.rb

@@ -118,13 +118,14 @@ def key_vals(attribute)
       end
 
       def escape_attributes(str = '')
-        return str if !(str.to_s =~ /["&<>]/)
+        return str if !(str.to_s =~ /["&<>\n]/)
 
         str.
           gsub(/&/, "&amp;").
           gsub(/"/, "&quot;").
           gsub(/</, "&lt;").
-          gsub(/>/, "&gt;")
+          gsub(/>/, "&gt;").
+          gsub(/\n/, "&#xA;")
       end
 
       def escape_data(str = '')

data/lib/write_xlsx/version.rb

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

data/lib/write_xlsx/workbook.rb

@@ -786,17 +786,18 @@ def set_properties(params)
 
       # List of valid input parameters.
       valid = {
-        :title       => 1,
-        :subject     => 1,
-        :author      => 1,
-        :keywords    => 1,
-        :comments    => 1,
-        :last_author => 1,
-        :created     => 1,
-        :category    => 1,
-        :manager     => 1,
-        :company     => 1,
-        :status      => 1
+        :title          => 1,
+        :subject        => 1,
+        :author         => 1,
+        :keywords       => 1,
+        :comments       => 1,
+        :last_author    => 1,
+        :created        => 1,
+        :category       => 1,
+        :manager        => 1,
+        :company        => 1,
+        :status         => 1,
+        :hyperlink_base => 1
       }
 
       # Check for valid input parameters.

data/lib/write_xlsx/worksheet.rb

@@ -296,6 +296,7 @@ class Worksheet
     attr_reader :comments, :comments_author # :nodoc:
     attr_accessor :dxf_priority # :nodoc:
     attr_reader :vba_codename # :nodoc:
+    attr_writer :excel_version
 
     def initialize(workbook, index, name) #:nodoc:
       @writer = Package::XMLWriterSimple.new
@@ -4288,7 +4289,7 @@ def conditional_formatting(*args)
     #     :header
     #     :formula
     #     :total_string
-    #     :total_function
+    #     :
     #     :format
     #
     # The column data must be specified as an array of hash. For example to
@@ -4916,9 +4917,8 @@ def insert_button(*args)
     #     :custom
     #
     # +:any+ is used to specify that the type of data is unrestricted.
-    # This is the same as not applying a data validation. It is only
-    # provided for completeness and isn't used very often in the
-    # context of WriteXLSX.
+    # This is usefl to display an input message without restricting the data
+    # that can be entered.
     #
     # +:integer+ restricts the cell to integer values. Excel refers to this
     # as 'whole number'.
@@ -5802,6 +5802,22 @@ def get_range_data(row_start, col_start, row_end, col_end) # :nodoc:
     #    width        # Width of object frame.
     #    height       # Height of object frame.
     def position_object_pixels(col_start, row_start, x1, y1, width, height) #:nodoc:
+      # Adjust start column for negative offsets.
+      while x1 < 0 && col_start > 0
+        x1 += size_col(col_start - 1)
+        col_start -= 1
+      end
+
+      # Adjust start row for negative offsets.
+      while y1 < 0 && row_start > 0
+        y1 += size_row(row_start - 1)
+        row_start -= 1
+      end
+      
+      # Ensure that the image isn't shifted off the page at top left.
+      x1 = 0 if x1 < 0
+      y1 = 0 if y1 < 0
+      
       # Calculate the absolute x offset of the top-left vertex.
       if @col_size_changed
         x_abs = (0 .. col_start-1).inject(0) {|sum, col| sum += size_col(col)}