write_xlsx 0.97.0 → 0.99.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1ecd38fb615885768458a04b082d759437fbaf7fb2e07900cc558d18e400e51
-  data.tar.gz: d1fa5e1696685c9bba199b4ee922c488144f5a2f852644e24fcedd38fed29035
+  metadata.gz: a8880984e96fe4a8788fe6642220163ff36932dea018a335d00165a7b2d2ae04
+  data.tar.gz: 99153b43aba51974cca58ed8c38d6308814820846b4617444fcd302752843bc5
 SHA512:
-  metadata.gz: 1162adaf9f347ef7f9e986b0596877edc9a4e059b1055e5913c576583017af41b78710c44252c2ced77b06dcdd818af269f3c98282e9bc767f211237e8313fac
-  data.tar.gz: cd4eb41156f364e4685487ae32876d8b35d7907f7f7068442fb22d2afc6a24217794bea5e571720d6db14b80b7c7368ac08502071d5290cc696cd80588901cdd
+  metadata.gz: 1b5c868f6e42846e925282b0eed02064b4541e852e72012e083009dbaa44e6bc419f1ad5b630cfe3ca149b12832732b972f340e6038502e1c8acbce9358702d2
+  data.tar.gz: 8bc6c84b0bb6c5901516441c7a5b1e45044ba5c26d30c92ac773f0de521e8e78785cd8aa4759a0d0db96d629aedd4aaf2a7453cb1f075b36dd1e61fc34cb217d

data/Changes

@@ -1,5 +1,32 @@
 Change history of write_xlsx rubygem.
 
+2021-01-08 v0.99.0
+
+   Added font and font_size parameters to write_comment().
+
+   Allow formulas in date field of data_validation().
+
+   Added top_left chart legend position.
+
+   Added legend formatting options.
+
+   Added set_tab_ratio() method to set the ratio between the worksheet tabs
+   and the horizontal slider.
+
+   Added worksheet hide_row_col_headers() method to turn off worksheet row
+   and column headings.
+
+   Add functionality to align chart category axis labels.
+
+   Fix for issue with special characters in worksheet table functions.
+
+   Fix handling of 'num_format': '0' in duplicate formats.
+
+
+2021-01-03 v0.98.0
+
+   fixed for autofilter rule with blanks plus another filter.
+
 2021-01-02 v0.97.0
 
    Added Excel 2010 data bar features such as solid fills and control over

data/LICENSE.txt

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

data/README.md

@@ -5,7 +5,7 @@
 
 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.97](https://github.com/jmcnamara/excel-writer-xlsx) .
+[Excel::Writer::XLSX-0.99](https://github.com/jmcnamara/excel-writer-xlsx) .
 
 ## Description
 
@@ -85,7 +85,7 @@ 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-2020 Hideo NAKAMURA.
+Copyright (c) 2012-2021 Hideo NAKAMURA.
 
 See LICENSE.txt for further details.
 

data/lib/write_xlsx/chart.rb

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/gradient'
+require 'write_xlsx/chart/legend'
 require 'write_xlsx/utility'
 require 'write_xlsx/chart/axis'
 require 'write_xlsx/chart/caption'
@@ -162,6 +163,7 @@ def numeric_or_downcase(val)
 
   class Chart
     include Writexlsx::Utility
+    include Writexlsx::Gradient
 
     attr_accessor :id, :name   # :nodoc:
     attr_writer :index, :palette, :protection   # :nodoc:
@@ -352,16 +354,8 @@ def set_title(params)
     # Set the properties of the chart legend.
     #
     def set_legend(params)
-      if params[:none]
-        @legend_position = 'none'
-      else
-        @legend_position = params[:position] || 'right'
-      end
-      @legend_delete_series = params[:delete_series]
-      @legend_font          = convert_font_args(params[:font])
-
-      # Set the legend layout.
-      @legend_layout = layout_properties(params[:layout])
+      # Convert the user default properties to internal properties.
+      legend_properties(params)
     end
 
     #
@@ -611,7 +605,7 @@ def display_setup
       @y_scale           = 1
       @x_offset          = 0
       @y_offset          = 0
-      @legend_position   = 'right'
+      @legend            = Legend.new
       @smooth_allowed    = 0
       @cross_between     = 'between'
       @date_category     = false
@@ -1240,7 +1234,7 @@ def write_cat_axis(params) # :nodoc:
         # Write the c:auto element.
         write_auto(1) unless x_axis.text_axis
         # Write the c:labelAlign element.
-        write_label_align('ctr')
+        write_label_align(x_axis.label_align)
         # Write the c:labelOffset element.
         write_label_offset(100)
         # Write the c:tickLblSkip element.
@@ -1574,6 +1568,12 @@ def write_auto(val) # :nodoc:
     # Write the <c:labelAlign> element.
     #
     def write_label_align(val) # :nodoc:
+      val ||= 'ctr'
+      if val == 'right'
+        val = 'r'
+      elsif val == 'left'
+        val = 'l'
+      end
       @writer.empty_tag('c:lblAlgn', [ ['val', val] ])
     end
 
@@ -1676,10 +1676,10 @@ def write_c_minor_time_unit(val) # :nodoc:
     # Write the <c:legend> element.
     #
     def write_legend # :nodoc:
-      position = @legend_position.sub(/^overlay_/, '')
+      position = @legend.position.sub(/^overlay_/, '')
       return if position == 'none' || (not position_allowed.has_key?(position))
 
-      @delete_series = @legend_delete_series if @legend_delete_series.kind_of?(Array)
+      @delete_series = @legend.delete_series if @legend.delete_series.kind_of?(Array)
       @writer.tag_elements('c:legend') do
         # Write the c:legendPos element.
         write_legend_pos(position_allowed[position])
@@ -1687,20 +1687,23 @@ def write_legend # :nodoc:
         # Write the c:legendEntry element.
         @delete_series.each { |i| write_legend_entry(i) } if @delete_series
         # Write the c:layout element.
-        write_layout(@legend_layout, 'legend')
-        # Write the c:txPr element.
-        write_tx_pr(nil, @legend_font) if ptrue?(@legend_font)
+        write_layout(@legend.layout, 'legend')
         # Write the c:overlay element.
-        write_overlay if @legend_position =~ /^overlay_/
+        write_overlay if @legend.position =~ /^overlay_/
+        # Write the c:spPr element.
+        write_sp_pr(@legend)
+        # Write the c:txPr element.
+        write_tx_pr(nil, @legend.font) if ptrue?(@legend.font)
       end
     end
 
     def position_allowed
       {
-        'right'  => 'r',
-        'left'   => 'l',
-        'top'    => 't',
-        'bottom' => 'b'
+        'right'     => 'r',
+        'left'      => 'l',
+        'top'       => 't',
+        'bottom'    => 'b',
+        'top_right' => 'tr'
       }
     end
 

data/lib/write_xlsx/chart/axis.rb

@@ -16,7 +16,7 @@ class Axis < Caption
       attr_reader :log_base, :crossing, :position_axis, :label_position, :visible
       attr_reader :num_format_linked, :num_font, :layout, :interval_unit
       attr_reader :interval_tick, :major_gridlines, :minor_gridlines, :reverse
-      attr_reader :line, :fill, :text_axis
+      attr_reader :line, :fill, :text_axis, :label_align
       #
       # Convert user defined axis values into axis instance.
       #
@@ -28,7 +28,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,
-          :interval_tick, :line, :fill
+          :interval_tick, :line, :fill, :label_align
         ].each { |val| instance_variable_set("@#{val}", args[val]) }
         set_major_minor_gridlines(args)
 

data/lib/write_xlsx/chart/legend.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+
+module Writexlsx
+  class Chart
+    class Legend
+      attr_accessor :line, :fill, :pattern, :gradient
+      attr_accessor :position, :delete_series, :layout, :font
+
+      def initialize
+        @position = 'right'
+      end
+    end
+  end
+end

data/lib/write_xlsx/chart/pie.rb

@@ -107,15 +107,15 @@ def write_plot_area
       # Write the <c:legend> element.
       #
       def write_legend
-        position = @legend_position
+        position = @legend.position
         allowed  = %w(right left top bottom)
-        delete_series = @legend_delete_series || []
+        delete_series = @legend.delete_series || []
 
-        if @legend_position =~ /^overlay_/
-          position = @legend_position.sub(/^overlay_/, '')
+        if @legend.position =~ /^overlay_/
+          position = @legend.position.sub(/^overlay_/, '')
           overlay = true
         else
-          position = @legend_position
+          position = @legend.position
           overlay = false
         end
 
@@ -129,11 +129,13 @@ def write_legend
           # Write the c:legendEntry element.
           delete_series.each { |index| write_legend_entry(index) }
           # Write the c:layout element.
-          write_layout(@legend_layout, 'legend')
+          write_layout(@legend.layout, 'legend')
           # Write the c:overlay element.
           write_overlay if overlay
+          # Write the c:spPr element.
+          write_sp_pr(@legend)
           # Write the c:txPr element. Over-ridden.
-          write_tx_pr_legend(0, @legend_font)
+          write_tx_pr_legend(0, @legend.font)
         end
       end
 

data/lib/write_xlsx/chartsheet.rb

@@ -57,11 +57,39 @@ def assemble_xml_file # :nodoc:
       end
     end
 
-    def protect(password = '', options = {})
+    def protect(password = '', user_options = nil, options = {})
+      # Objects are default on for chartsheets.
+      if user_options
+        if user_options.has_key?(:objects)
+          if ptrue?(user_options[:objects])
+            options[:objects] = 0
+          else
+            options[:objects] = 1
+          end
+        else
+          options[:objects] = 0
+        end
+
+        if user_options.has_key?(:content)
+          options[:content] = user_options[:content]
+        else
+          options[:content] = 1
+        end
+      else
+        options[:objects] = 0
+        options[:content] = 1
+      end
+
+      # Is objects and content are off then the chartsheet isn't locked.
+      # except if it has a password.
+      if password == '' && ptrue?(options[:objects]) && !ptrue?(options[:content])
+        return
+      end
+
       @chart.protection = 1
 
+      # Turn off worksheet defaults.
       options[:sheet]     = 0
-      options[:content]   = 1
       options[:scenarios] = 1
 
       super(password, options)

data/lib/write_xlsx/format.rb

@@ -180,7 +180,7 @@ def initialize(formats, params = {})   # :nodoc:
       @xf_index       = nil
       @dxf_index      = nil
 
-      @num_format     = 0
+      @num_format     = 'General'
       @num_format_index = 0
       @font_index     = 0
       @font           = 'Calibri'
@@ -478,13 +478,13 @@ def self.color(color_code)
 
       colors = Colors::COLORS
 
+      # Return the default color if nil,
+      return 0x00 unless color_code
+
       if color_code.respond_to?(:to_str)
         # Return RGB style colors for processing later.
         return color_code if color_code =~ /^#[0-9A-F]{6}$/i
 
-        # Return the default color if undef,
-        return 0x00 unless color_code
-
         # or the color string converted to an integer,
         return colors[color_code.downcase.to_sym] if colors[color_code.downcase.to_sym]
 

data/lib/write_xlsx/package/comments.rb

@@ -14,28 +14,29 @@ class Comment
       DEFAULT_HEIGHT = 74
 
       attr_reader :row, :col, :string, :color, :vertices
+      attr_reader :font_size, :font_family
       attr_accessor :author, :visible
 
       def initialize(workbook, worksheet, row, col, string, options = {})
         options ||= {}
-        @workbook   = workbook
-        @worksheet  = worksheet
-        @row, @col  = row, col
+        @workbook    = workbook
+        @worksheet   = worksheet
+        @row, @col   = row, col
         options_parse(row, col, options)
-        @string     = string[0, STR_MAX]
-        @start_row  ||= default_start_row(row)
-        @start_col  ||= default_start_col(col)
-        @visible    = options[:visible]
-        @x_offset   = options[:x_offset] || default_x_offset(col)
-        @y_offset   = options[:y_offset] || default_y_offset(row)
-        @x_scale    = options[:x_scale]  || 1
-        @y_scale    = options[:y_scale]  || 1
-        @width      = (0.5 + (options[:width]  || DEFAULT_WIDTH)  * @x_scale).to_i
-        @height     = (0.5 + (options[:height] || DEFAULT_HEIGHT) * @y_scale).to_i
-        @vertices   = @worksheet.position_object_pixels(
-                                             @start_col, @start_row, @x_offset, @y_offset,
-                                             @width, @height
-                                             ) << [@width, @height]
+        @string      = string[0, STR_MAX]
+        @start_row   ||= default_start_row(row)
+        @start_col   ||= default_start_col(col)
+        @visible     = options[:visible]
+        @x_offset    = options[:x_offset] || default_x_offset(col)
+        @y_offset    = options[:y_offset] || default_y_offset(row)
+        @x_scale     = options[:x_scale]  || 1
+        @y_scale     = options[:y_scale]  || 1
+        @width       = (0.5 + (options[:width]  || DEFAULT_WIDTH)  * @x_scale).to_i
+        @height      = (0.5 + (options[:height] || DEFAULT_HEIGHT) * @y_scale).to_i
+        @vertices    = @worksheet.position_object_pixels(
+          @start_col, @start_row, @x_offset, @y_offset,
+          @width, @height
+        ) << [@width, @height]
       end
 
       def backgrount_color(color)
@@ -213,24 +214,31 @@ def writer=(w)
         @writer = w
       end
 
+      def font_name
+        @font
+      end
+
       private
 
       def options_parse(row, col, options)
-        @color      = backgrount_color(options[:color] || DEFAULT_COLOR)
-        @author     = options[:author]
-        @start_cell = options[:start_cell]
+        @color       = backgrount_color(options[:color] || DEFAULT_COLOR)
+        @author      = options[:author]
+        @start_cell  = options[:start_cell]
         @start_row, @start_col = if @start_cell
           substitute_cellref(@start_cell)
         else
           [ options[:start_row], options[:start_col] ]
         end
-        @visible    = options[:visible]
-        @x_offset   = options[:x_offset] || default_x_offset(col)
-        @y_offset   = options[:y_offset] || default_y_offset(row)
-        @x_scale    = options[:x_scale]  || 1
-        @y_scale    = options[:y_scale]  || 1
-        @width      = (0.5 + (options[:width]  || DEFAULT_WIDTH)  * @x_scale).to_i
-        @height     = (0.5 + (options[:height] || DEFAULT_HEIGHT) * @y_scale).to_i
+        @visible     = options[:visible]
+        @x_offset    = options[:x_offset]       || default_x_offset(col)
+        @y_offset    = options[:y_offset]       || default_y_offset(row)
+        @x_scale     = options[:x_scale]        || 1
+        @y_scale     = options[:y_scale]        || 1
+        @font        = options[:font]           || 'Tahoma'
+        @font_size   = options[:font_size]      || 8
+        @font_family = options[:font_family]    || 2
+        @width       = (0.5 + (options[:width]  || DEFAULT_WIDTH)  * @x_scale).to_i
+        @height      = (0.5 + (options[:height] || DEFAULT_HEIGHT) * @y_scale).to_i
       end
     end
 
@@ -366,36 +374,37 @@ def write_comment(comment)
         attributes << ['authorId', author_id]
 
         @writer.tag_elements('comment', attributes) do
-          write_text(comment.string)
+          write_text(comment)
         end
       end
 
       #
       # Write the <text> element.
       #
-      def write_text(text)
+      def write_text(comment)
         @writer.tag_elements('text') do
           # Write the text r element.
-          write_text_r(text)
+          write_text_r(comment)
         end
       end
 
       #
       # Write the <r> element.
       #
-      def write_text_r(text)
+      def write_text_r(comment)
         @writer.tag_elements('r') do
           # Write the rPr element.
-          write_r_pr
+          write_r_pr(comment)
           # Write the text r element.
-          write_text_t(text)
+          write_text_t(comment)
         end
       end
 
       #
       # Write the text <t> element.
       #
-      def write_text_t(text)
+      def write_text_t(comment)
+        text = comment.string
         attributes = []
 
         attributes << ['xml:space', 'preserve'] if text =~ /^\s/ || text =~ /\s$/
@@ -406,25 +415,23 @@ def write_text_t(text)
       #
       # Write the <rPr> element.
       #
-      def write_r_pr
+      def write_r_pr(comment)
         @writer.tag_elements('rPr') do
           # Write the sz element.
-          write_sz
+          write_sz(comment.font_size)
           # Write the color element.
           write_color
           # Write the rFont element.
-          write_r_font
+          write_r_font(comment.font_name)
           # Write the family element.
-          write_family
+          write_family(comment.font_family)
         end
       end
 
       #
       # Write the <sz> element.
       #
-      def write_sz
-        val  = 8
-
+      def write_sz(val)
         attributes = [ ['val', val] ]
 
         @writer.empty_tag('sz', attributes)
@@ -440,9 +447,7 @@ def write_color
       #
       # Write the <rFont> element.
       #
-      def write_r_font
-        val  = 'Tahoma'
-
+      def write_r_font(val)
         attributes = [ ['val', val] ]
 
         @writer.empty_tag('rFont', attributes)
@@ -451,9 +456,7 @@ def write_r_font
       #
       # Write the <family> element.
       #
-      def write_family
-        val  = 2
-
+      def write_family(val)
         attributes = [ ['val', val] ]
 
         @writer.empty_tag('family', attributes)