write_xlsx 0.85.9 → 1.09.2

data/lib/write_xlsx/package/comments.rb

@@ -14,38 +14,41 @@ module Writexlsx
       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)
         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
 
@@ -152,7 +155,7 @@ module Writexlsx
       #
       def fill_attributes
         [
-         ['color2', '#ffffe1']
+          ['color2', '#ffffe1']
         ]
       end
 
@@ -161,9 +164,9 @@ module Writexlsx
       #
       def write_shadow
         attributes = [
-            ['on',       't'],
-            ['color',    'black'],
-            ['obscured', 't']
+          ['on',       't'],
+          ['color',    'black'],
+          ['obscured', 't']
         ]
 
         @writer.empty_tag('v:shadow', attributes)
@@ -174,8 +177,8 @@ module Writexlsx
       #
       def write_textbox
         attributes = [
-                      ['style', 'mso-direction-alt:auto']
-                     ]
+          ['style', 'mso-direction-alt:auto']
+        ]
 
         @writer.tag_elements('v:textbox', attributes) do
           # Write the div element.
@@ -188,8 +191,8 @@ module Writexlsx
       #
       def write_client_data
         attributes = [
-                      ['ObjectType', 'Note']
-                     ]
+          ['ObjectType', 'Note']
+        ]
 
         @writer.tag_elements('x:ClientData', attributes) do
           @writer.empty_tag('x:MoveWithCells')
@@ -211,24 +214,31 @@ module Writexlsx
         @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
+                                   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
+        @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
 
@@ -247,13 +257,9 @@ module Writexlsx
         @comments[row]
       end
 
-      def add(comment)
-        if @comments[comment.row]
-          @comments[comment.row][comment.col] = comment
-        else
-          @comments[comment.row] = {}
-          @comments[comment.row][comment.col] = comment
-        end
+      def add(workbook, worksheet, row, col, string, options)
+        @comments[row] ||= {}
+        @comments[row][col] = [workbook, worksheet, row, col, string, options]
       end
 
       def empty?
@@ -283,6 +289,10 @@ module Writexlsx
           # We sort the comments by row and column but that isn't strictly required.
           @comments.keys.sort.each do |row|
             @comments[row].keys.sort.each do |col|
+              user_options = @comments[row][col]
+              comment = Comment.new(*user_options)
+              @comments[row][col] = comment
+
               # Set comment visibility if required and not already user defined.
               @comments[row][col].visible ||= 1 if comments_visible?
 
@@ -364,36 +374,37 @@ module Writexlsx
         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$/
@@ -404,25 +415,23 @@ module Writexlsx
       #
       # 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)
@@ -438,9 +447,7 @@ module Writexlsx
       #
       # Write the <rFont> element.
       #
-      def write_r_font
-        val  = 'Tahoma'
-
+      def write_r_font(val)
         attributes = [ ['val', val] ]
 
         @writer.empty_tag('rFont', attributes)
@@ -449,9 +456,7 @@ module Writexlsx
       #
       # Write the <family> element.
       #
-      def write_family
-        val  = 2
-
+      def write_family(val)
         attributes = [ ['val', val] ]
 
         @writer.empty_tag('family', attributes)