write_xlsx 0.97.0 → 0.99.0

data/lib/write_xlsx/package/conditional_format.rb

@@ -749,7 +749,15 @@ def write_cf_rule
             write_formula_tag(maximum)
           end
         else
-          write_cf_rule_formula_tag(value)
+          quoted_value = value.to_s
+          numeric_regex = /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/
+          # String "Cell" values must be quoted, apart from ranges.
+          if !(quoted_value =~ /(\$?)([A-Z]{1,3})(\$?)(\d+)/) &&
+             !(quoted_value =~ numeric_regex) &&
+             !(quoted_value =~ /^".*"$/)
+            quoted_value = (%Q!"#{value}"!)
+          end
+          write_cf_rule_formula_tag(quoted_value)
         end
       end
     end

data/lib/write_xlsx/package/table.rb

@@ -240,6 +240,11 @@ def handle_the_function_for_the_table_row(row2, col_data, col_num, user_data)
       # Convert a table total function to a worksheet formula.
       #
       def table_function_to_formula(function, col_name)
+        col_name = col_name.gsub(/'/, "''").
+                     gsub(/#/, "'#").
+                     gsub(/\[/, "'[").
+                     gsub(/\]/, "']")
+
         subtotals = {
           :average   => 101,
           :countNums => 102,

data/lib/write_xlsx/utility.rb

@@ -119,7 +119,7 @@ def check_dimensions(row, col)
     #            nil if the date is invalid.
     #
     def convert_date_time(date_time_string)       #:nodoc:
-      date_time = date_time_string.sub(/^\s+/, '').sub(/\s+$/, '').sub(/Z$/, '')
+      date_time = date_time_string.to_s.sub(/^\s+/, '').sub(/\s+$/, '').sub(/Z$/, '')
 
       # Check for invalid date char.
       return nil if date_time =~ /[^0-9T:\-\.Z]/
@@ -361,6 +361,64 @@ def float_to_str(float)
       end
     end
 
+    #
+    # Convert user defined legend properties to the structure required internally.
+    #
+    def legend_properties(params)
+      legend = Writexlsx::Chart::Legend.new
+
+      legend.position      = params[:position] || 'right'
+      legend.delete_series = params[:delete_series]
+      legend.font          = convert_font_args(params[:font])
+
+      # Set the legend layout.
+      legend.layout = layout_properties(params[:layout])
+
+      # Turn off the legend.
+      if params[:none]
+        legend.position = 'none'
+      end
+
+      # Set the line properties for the legend.
+      line = line_properties(params[:line])
+
+      # Allow 'border' as a synonym for 'line'.
+      if params[:border]
+        line = line_properties(params[:border])
+      end
+
+      # Set the fill properties for the legend.
+      fill = fill_properties(params[:fill])
+
+      # Set the pattern properties for the legend.
+      pattern = pattern_properties(params[:pattern])
+
+      # Set the gradient fill properties for the legend.
+      gradient = gradient_properties(params[:gradient])
+
+      # Pattern fill overrides solid fill.
+      if pattern
+        fill = nil
+      end
+
+      # Gradient fill overrides solid and pattern fills.
+      if gradient
+        pattern = nil
+        fill    = nil
+      end
+
+      # Set the legend layout.
+      layout = layout_properties(params[:layout])
+
+      legend.line     = line
+      legend.fill     = fill
+      legend.pattern  = pattern
+      legend.gradient = gradient
+      legend.layout   = layout
+
+      @legend = legend
+    end
+
     #
     # Convert user defined layout properties to the format required internally.
     #

data/lib/write_xlsx/version.rb

@@ -1 +1 @@
-WriteXLSX_VERSION = "0.97.0"
+WriteXLSX_VERSION = "0.99.0"

data/lib/write_xlsx/workbook.rb

@@ -123,7 +123,7 @@ def initialize(file, *option_params)
       @y_window            = 15
       @window_width        = 16095
       @window_height       = 9660
-      @tab_ratio           = 500
+      @tab_ratio           = 600
       @excel2003_style     = options[:excel2003_style] || false
       @table_count         = 0
       @image_types         = {}
@@ -784,6 +784,19 @@ def set_size(width = nil, height = nil)
       end
     end
 
+    #
+    # Set the ratio of space for worksheet tabs.
+    #
+    def set_tab_ratio(tab_ratio = nil)
+      return if !tab_ratio
+
+      if tab_ratio < 0 || tab_ratio > 100
+        raise "Tab ratio outside range: 0 <= zoom <= 100"
+      else
+        @tab_ratio = (tab_ratio * 10).to_i
+      end
+    end
+
     #
     # The set_properties method can be used to set the document properties
     # of the Excel file created by WriteXLSX. These properties are visible
@@ -1308,7 +1321,7 @@ def write_workbook_view #:nodoc:
                     ['windowWidth',   @window_width],
                     ['windowHeight',  @window_height]
                    ]
-      if @tab_ratio != 500
+      if @tab_ratio != 600
         attributes << ['tabRatio', @tab_ratio]
       end
       if @firstsheet > 0
@@ -1512,9 +1525,17 @@ def prepare_num_formats #:nodoc:
         # string but would evaluate to zero.
         #
         if num_format.to_s =~ /^\d+$/ && num_format.to_s !~ /^0+\d/
+          # Number format '0' is indexed as 1 in Excel.
+          if num_format == 0
+            num_format = 1
+          end
           # Index to a built-in number format.
           format.num_format_index = num_format
           next
+        elsif num_format.to_s == 'General'
+          # The 'General' format has an number format index of 0.
+          format.num_format_index = 0
+          next
         end
 
         if num_formats[num_format]
@@ -2064,16 +2085,20 @@ def process_jpg(data, filename)
       offset = 2
       data_length = data.bytesize
 
-      # Search through the image data to read the height and width in the
-      # 0xFFC0/C2 element. Also read the DPI in the 0xFFE0 element.
+      # Search through the image data to read the JPEG markers.
       while offset < data_length
         marker  = data[offset+0, 2].unpack("n")[0]
         length  = data[offset+2, 2].unpack("n")[0]
 
-        if marker == 0xFFC0 || marker == 0xFFC2
+        # Read the height and width in the 0xFFCn elements
+        # (Except C4, C8 and CC which aren't SOF markers).
+        if (marker & 0xFFF0) == 0xFFC0 &&
+           marker != 0xFFC4 && marker != 0xFFCC
           height = data[offset+5, 2].unpack("n")[0]
           width  = data[offset+7, 2].unpack("n")[0]
         end
+
+        # Read the DPI in the 0xFFE0 element.
         if marker == 0xFFE0
           units     = data[offset + 11, 1].unpack("C")[0]
           x_density = data[offset + 12, 2].unpack("n")[0]

data/lib/write_xlsx/worksheet.rb

@@ -312,14 +312,15 @@ def initialize(workbook, index, name) #:nodoc:
 
       @page_setup = PageSetup.new
 
-      @screen_gridlines = true
-      @show_zeros = true
-      @dim_rowmin = nil
-      @dim_rowmax = nil
-      @dim_colmin = nil
-      @dim_colmax = nil
-      @selections = []
-      @panes = []
+      @screen_gridlines     = true
+      @show_zeros           = true
+      @dim_rowmin           = nil
+      @dim_rowmax           = nil
+      @dim_colmin           = nil
+      @dim_colmax           = nil
+      @selections           = []
+      @panes                = []
+      @hide_row_col_headers = 0
 
       @tab_color  = 0
 
@@ -5344,6 +5345,13 @@ def print_row_col_headers(headers = true)
       # end
     end
 
+    #
+    # Set the option to hide the row and column headers in Excel.
+    #
+    def hide_row_col_headers
+      @hide_row_col_headers = 1
+    end
+
     #
     # The fit_to_pages() method is used to fit the printed area to a specific
     # number of pages both vertically and horizontally. If the printed area
@@ -6757,9 +6765,12 @@ def write_sheet_views #:nodoc:
 
     def write_sheet_view #:nodoc:
       attributes = []
-      # Hide screen gridlines if required
+      # Hide screen gridlines if required.
       attributes << ['showGridLines', 0] unless @screen_gridlines
 
+      # Hide the row/column headers.
+      attributes << ['showRowColHeaders', 0] if ptrue?(@hide_row_col_headers)
+
       # Hide zeroes in cells.
       attributes << ['showZeros', 0] unless show_zeros?
 
@@ -7294,13 +7305,20 @@ def write_filter_column(col_id, type, *filters) #:nodoc:
     # Write the <filters> element.
     #
     def write_filters(*filters) #:nodoc:
-      if filters.size == 1 && filters[0] == 'blanks'
+      non_blanks = filters.reject { |filter| filter =~ /^blanks$/i }
+      attributes = []
+
+      if filters != non_blanks
+        attributes = [ ['blank', 1] ]
+      end
+
+      if filters.size == 1 && non_blanks.empty?
         # Special case for blank cells only.
-        @writer.empty_tag('filters', [ ['blank', 1] ])
+        @writer.empty_tag('filters', attributes)
       else
         # General case.
-        @writer.tag_elements('filters') do
-          filters.each { |filter| write_filter(filter) }
+        @writer.tag_elements('filters', attributes) do
+          non_blanks.sort.each { |filter| write_filter(filter) }
         end
       end
     end

data/lib/write_xlsx/worksheet/data_validation.rb

@@ -219,10 +219,17 @@ def check_valid_citeria_types
       end
 
       def convert_date_time_value_if_required
-        @date_1904 = date_1904?
         if @validate == 'date' || @validate == 'time'
-          unless convert_date_time_value(:value) && convert_date_time_value(:maximum)
-            raise WriteXLSXOptionParameterError, "Invalid date/time value."
+          date_time = convert_date_time(@value)
+          if date_time
+            @value = date_time
+          end
+
+          if @maximum
+            date_time = convert_date_time(@maximum)
+            if date_time
+              @maximum = date_time
+            end
           end
         end
       end
@@ -292,17 +299,6 @@ def valid_criteria_type  # :nodoc:
         }
       end
 
-      def convert_date_time_value(key)  # :nodoc:
-        value = instance_variable_get("@#{key}")
-        if value && value.to_s =~ /T/
-          date_time = convert_date_time(value)
-          instance_variable_set("@#{key}", date_time) if date_time
-          date_time
-        else
-          true
-        end
-      end
-
       def date_1904?
         @date_1904
       end

data/test/chart/test_write_legend_pos.rb

@@ -7,9 +7,17 @@ def setup
     @chart = Writexlsx::Chart.new('Bar')
   end
 
-  def test_write_legend_pos
+  def test_write_legend_pos_default
     expected = '<c:legendPos val="r"/>'
     result = @chart.__send__('write_legend_pos', 'r')
     assert_equal(expected, result)
   end
+
+  def test_write_legend_overlay_top_right
+    expected = '<c:legend><c:legendPos val="tr"/><c:layout/><c:overlay val="1"/></c:legend>'
+    @chart.set_legend(:position => 'overlay_top_right')
+    @chart.__send__('write_legend')
+    result = @chart.instance_variable_get(:@writer).string
+    assert_equal(expected, result)
+  end
 end

data/test/chartsheet/test_write_sheet_protection.rb

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestChartsheetWriteSheetProtection < Minitest::Test
+  def setup
+    workbook = WriteXLSX.new(StringIO.new)
+    workbook.add_chart(:type => 'line')
+    @chartsheet = workbook.sheets.first
+  end
+
+  def test_chartsheet_write_sheet_protection
+    expected = '<sheetProtection password="83AF" content="1" objects="1"/>'
+
+    @chartsheet.protect('', {})
+    result = @chartsheet.__send__(:write_sheet_protection)
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+
+  def test_chartsheet_write_sheet_protection
+    expected = '<sheetProtection password="83AF" content="1" objects="1"/>'
+
+    @chartsheet.protect('password', {})
+    result = @chartsheet.__send__(:write_sheet_protection)
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+
+  def test_chartsheet_write_sheet_protection_without_password_and_content
+    expected = '<sheetProtection content="1"/>'
+
+    @chartsheet.protect('', {:objects => 0})
+    result = @chartsheet.__send__(:write_sheet_protection)
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+
+  def test_chartsheet_write_sheet_protection_with_opjects0_option
+    expected = '<sheetProtection password="83AF" content="1"/>'
+
+    @chartsheet.protect('password', { :objects => 0 })
+    result = @chartsheet.__send__(:write_sheet_protection)
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+
+  def test_chartsheet_write_sheet_protection_without_password
+    expected = '<sheetProtection objects="1"/>'
+
+    @chartsheet.protect('', { :content => 0 })
+    result = @chartsheet.__send__(:write_sheet_protection)
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+
+  def test_chartsheet_write_sheet_protection_without_password_and_content_option
+    expected = ''
+
+    @chartsheet.protect('', { :content => 0, :objects => 0 })
+    result = @chartsheet.__send__(:write_sheet_protection) || ''
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+
+  def test_chartsheet_write_sheet_protection_with_password_and_content_objects_option
+    expected = '<sheetProtection password="83AF"/>'
+
+    @chartsheet.protect('password', { :content => 0, :objects => 0 })
+    result = @chartsheet.__send__(:write_sheet_protection)
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+
+  def test_chartsheet_write_sheet_protection_with_password_full_options
+    expected = '<sheetProtection password="83AF" content="1" objects="1"/>'
+
+    options = {
+      :objects               => 1,
+      :scenarios             => 1,
+      :format_cells          => 1,
+      :format_columns        => 1,
+      :format_rows           => 1,
+      :insert_columns        => 1,
+      :insert_rows           => 1,
+      :insert_hyperlinks     => 1,
+      :delete_columns        => 1,
+      :delete_rows           => 1,
+      :select_locked_cells   => 0,
+      :sort                  => 1,
+      :autofilter            => 1,
+      :pivot_tables          => 1,
+      :select_unlocked_cells => 0
+    }
+    @chartsheet.protect('password', options)
+    result = @chartsheet.__send__(:write_sheet_protection)
+    assert_equal(expected_to_array(expected), got_to_array(result))
+  end
+end

data/test/package/comments/test_comments_01.rb

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestComments01 < Minitest::Test
+  def setup
+    @workbook = WriteXLSX.new(StringIO.new)
+    @worksheet = @workbook.add_worksheet('')
+  end
+
+  ###############################################################################
+  #
+  # Test the _assemble_xml_file() method.
+  #
+  def test_assemble_xml_file
+    @worksheet.write_comment(
+      1, 1, 'Some text',
+      :author => 'John', :visible => nil, :color => 81,
+      :font => 'Tahoma', :font_size => 8, :font_family => 2
+    )
+
+    comments = @worksheet.comments
+    comments.assemble_xml_file
+    result = got_to_array(comments.instance_variable_get(:@writer).string)
+
+    expected = expected_to_array(expected_xml)
+    assert_equal(expected, result)
+  end
+
+  def expected_xml
+    <<EOS
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<comments xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">
+  <authors>
+    <author>John</author>
+  </authors>
+  <commentList>
+    <comment ref="B2" authorId="0">
+      <text>
+        <r>
+          <rPr>
+            <sz val="8"/>
+            <color indexed="81"/>
+            <rFont val="Tahoma"/>
+            <family val="2"/>
+          </rPr>
+          <t>Some text</t>
+        </r>
+      </text>
+    </comment>
+  </commentList>
+</comments>
+EOS
+  end
+end