write_xlsx 0.0.2 → 0.0.3

data/lib/write_xlsx/package/comments.rb

@@ -1,35 +1,195 @@
 # -*- coding: utf-8 -*-
+require 'write_xlsx/format'
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/utility'
 
 module Writexlsx
   module Package
+
+    class Comment
+
+      include Writexlsx::Utility
+
+      DEFAULT_COLOR  = 81  # what color ?
+      DEFAULT_WIDTH  = 128
+      DEFAULT_HEIGHT = 74
+
+      attr_reader :row, :col, :string, :color, :vertices
+      attr_accessor :author, :visible
+
+      def initialize(workbook, worksheet, row, col, string, options = {})
+        options ||= {}
+        @workbook   = workbook
+        @worksheet  = worksheet
+        @row        = row
+        @col        = col
+        @string     = string[0, STR_MAX]
+        @author     = options[:author]
+        @color      = backgrount_color(options[:color] || DEFAULT_COLOR)
+        @start_cell = options[:start_cell]
+        @start_row, @start_col = if @start_cell
+          substitute_cellref(@start_cell)
+        else
+          [ options[:start_row], options[:start_col] ]
+        end
+        @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.get_color(color)
+
+        if color_id == 0
+          @color = '#ffffe1'
+        else
+          rgb = @workbook.palette[color_id - 8]
+          @color = "##{rgb_color(rgb)} [#{color_id}]\n"
+        end
+      end
+
+      # Minor modification to allow comparison testing. Change RGB colors
+      # from long format, ffcc00 to short format fc0 used by VML.
+      def rgb_color(rgb)
+        result = sprintf("%02x%02x%02x", *rgb)
+        if result =~ /^([0-9a-f])\1([0-9a-f])\2([0-9a-f])\3$/
+          result = "#{$1}#{$2}#{$3}"
+        end
+        result
+      end
+
+      def default_start_row(row)
+        case row
+        when 0
+          0
+        when ROW_MAX - 3
+          ROW_MAX - 7
+        when ROW_MAX - 2
+          ROW_MAX - 6
+        when ROW_MAX - 1
+          ROW_MAX - 5
+        else
+          row - 1
+        end
+      end
+
+      def default_start_col(col)
+        case col
+        when COL_MAX - 3
+          COL_MAX - 6
+        when COL_MAX - 2
+          COL_MAX - 5
+        when COL_MAX - 1
+          COL_MAX - 4
+        else
+          col + 1
+        end
+      end
+
+      def default_x_offset(col)
+        case col
+        when COL_MAX - 3, COL_MAX - 2, COL_MAX - 1
+          49
+        else
+          15
+        end
+      end
+
+      def default_y_offset(row)
+        case row
+        when 0
+          2
+        when ROW_MAX - 3, ROW_MAX - 2
+          16
+        when ROW_MAX - 1
+          14
+        else
+          10
+        end
+      end
+    end
+
     class Comments
 
       include Writexlsx::Utility
 
-      def initialize
+      def initialize(worksheet)
+        @worksheet = worksheet
         @writer = Package::XMLWriterSimple.new
         @author_ids = {}
+        @comments = {}
+      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
+      end
+
+      def empty?
+        @comments.empty?
+      end
+
+      def size
+        sorted_comments.size
       end
 
       def set_xml_writer(filename)
         @writer.set_xml_writer(filename)
       end
 
-      def assemble_xml_file(comments_data)
+      def assemble_xml_file
         write_xml_declaration
         write_comments
-        write_authors(comments_data)
-        write_comment_list(comments_data)
+        write_authors(sorted_comments)
+        write_comment_list(sorted_comments)
 
         @writer.end_tag('comments')
         @writer.crlf
         @writer.close
       end
 
+      def sorted_comments
+        @sorted_comments if @sorted_comments
+
+        @sorted_comments = []
+        # 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|
+            # Set comment visibility if required and not already user defined.
+            @comments[row][col].visible ||= 1 if comments_visible?
+
+            # Set comment author if not already user defined.
+            @comments[row][col].author ||= @comments_author
+            @sorted_comments << @comments[row][col]
+          end
+        end
+        @sorted_comments
+      end
+
+      def has_comment_in_row?(row)
+        !!@comments[row]
+      end
+
       private
 
+      def comments_visible?
+        @worksheet.comments_visible?
+      end
+
       def write_xml_declaration
         @writer.xml_decl
       end
@@ -53,8 +213,7 @@ module Writexlsx
 
         @writer.start_tag('authors')
         comment_data.each do |comment|
-          author = comment[3] || ''
-
+          author = comment.author || ''
           if author && !@author_ids[author]
             # Store the author id.
             @author_ids[author] = author_count
@@ -80,37 +239,22 @@ module Writexlsx
       #
       def write_comment_list(comment_data)
         @writer.start_tag('commentList')
-
-        comment_data.each do |comment|
-          row    = comment[0]
-          col    = comment[1]
-          text   = comment[2]
-          author = comment[3]
-
-          # Look up the author id.
-          author_id = nil
-          author_id = @author_ids[author] if author
-
-          # Write the comment element.
-          write_comment(row, col, text, author_id)
-        end
-
+        comment_data.each { |comment| write_comment(comment) }
         @writer.end_tag( 'commentList' )
       end
 
       #
       # Write the <comment> element.
       #
-      def write_comment(row, col, text, author_id)
-        ref       = xl_rowcol_to_cell( row, col )
-        author_id ||= 0
-
+      def write_comment(comment)
+        ref       = xl_rowcol_to_cell( comment.row, comment.col )
         attributes = ['ref', ref]
 
-        (attributes << 'authorId' << author_id ) if author_id
+        author_id = (@author_ids[comment.author] if comment.author) || 0
+        attributes << 'authorId' << author_id
 
         @writer.start_tag('comment', attributes)
-        write_text(text)
+        write_text(comment.string)
         @writer.end_tag('comment')
       end
 

data/lib/write_xlsx/package/packager.rb

@@ -157,14 +157,10 @@ module Writexlsx
           next unless worksheet.has_comments?
           FileUtils.mkdir_p("#{@package_dir}/xl/drawings")
 
-          vml = Package::VML.new
+          vml = Package::Vml.new
           vml.set_xml_writer("#{@package_dir}/xl/drawings/vmlDrawing#{index}.vml")
           index += 1
-          vml.assemble_xml_file(
-            worksheet.vml_data_id,
-            worksheet.vml_shape_id,
-            worksheet.comments_array
-          )
+          vml.assemble_xml_file(worksheet)
         end
       end
 
@@ -177,12 +173,11 @@ module Writexlsx
           next unless worksheet.has_comments?
 
           FileUtils.mkdir_p("#{@package_dir}/xl/drawings")
-          comment = Package::Comments.new
 
-          comment.set_xml_writer("#{@package_dir}/xl/comments#{index}.xml")
+          worksheet.comments_xml_writer = "#{@package_dir}/xl/comments#{index}.xml"
           index += 1
 
-          comment.assemble_xml_file(worksheet.comments_array)
+          worksheet.comments_assemble_xml_file
         end
       end
 
@@ -190,15 +185,11 @@ module Writexlsx
       # Write the sharedStrings.xml file.
       #
       def write_shared_strings_file
-        sst  = Package::SharedStrings.new
+        sst  = @workbook.shared_strings
 
         FileUtils.mkdir_p("#{@package_dir}/xl")
 
-        return unless @workbook.str_total > 0
-
-        sst.string_count = @workbook.str_total
-        sst.unique_count = @workbook.str_unique
-        sst.add_strings(@workbook.str_array)
+        return if @workbook.shared_strings_empty?
 
         sst.set_xml_writer("#{@package_dir}/xl/sharedStrings.xml")
         sst.assemble_xml_file
@@ -288,7 +279,7 @@ module Writexlsx
         (1 .. @num_comment_files).each { |i| content.add_comment_name("comments#{i}") }
 
         # Add the sharedString rel if there is string data in the workbook.
-        content.add_shared_strings if @workbook.str_total > 0
+        content.add_shared_strings unless @workbook.shared_strings_empty?
 
         content.set_xml_writer("#{@package_dir}/[Content_Types].xml")
         content.assemble_xml_file
@@ -380,7 +371,7 @@ module Writexlsx
         rels.add_document_relationship('/styles', 'styles.xml')
 
         # Add the sharedString rel if there is string data in the workbook.
-        rels.add_document_relationship('/sharedStrings', 'sharedStrings.xml') if @workbook.str_total != 0
+        rels.add_document_relationship('/sharedStrings', 'sharedStrings.xml') unless @workbook.shared_strings_empty?
         rels.set_xml_writer("#{@package_dir}/xl/_rels/workbook.xml.rels")
         rels.assemble_xml_file
       end

data/lib/write_xlsx/package/shared_strings.rb

@@ -8,13 +8,33 @@ module Writexlsx
 
       include Writexlsx::Utility
 
-      attr_writer :string_count, :unique_count
-
       def initialize
-        @writer = Package::XMLWriterSimple.new
-        @strings      = []
-        @string_count = 0
-        @unique_count = 0
+        @writer  = Package::XMLWriterSimple.new
+        @strings = [] # string table
+        @count   = {} # => count
+      end
+
+      def index(string)
+        add(string)
+        @strings.index(string)
+      end
+
+      def add(string)
+        str = string.dup
+        if @count[str]
+          @count[str] += 1
+        else
+          @strings << str
+          @count[str] = 1
+        end
+      end
+
+      def string(index)
+        @strings[index].dup
+      end
+
+      def empty?
+        @strings.empty?
       end
 
       def set_xml_writer(filename)
@@ -36,13 +56,6 @@ module Writexlsx
         @writer.close
       end
 
-      #
-      # Add the array ref of strings to be written.
-      #
-      def add_strings(strings)
-        @strings = strings
-      end
-
       private
 
       def write_xml_declaration
@@ -58,8 +71,8 @@ module Writexlsx
         attributes =
           [
            'xmlns',       schema + '/spreadsheetml/2006/main',
-           'count',       @string_count,
-           'uniqueCount', @unique_count
+           'count',       total_count,
+           'uniqueCount', unique_count
           ]
 
         @writer.start_tag('sst', attributes)
@@ -91,6 +104,14 @@ module Writexlsx
 
         @writer.end_tag('si')
       end
+
+      def total_count
+        @count.values.inject(0) { |sum, count| sum += count }
+      end
+
+      def unique_count
+        @strings.size
+      end
     end
   end
 end

data/lib/write_xlsx/package/styles.rb

@@ -238,17 +238,7 @@ module Writexlsx
       # Write the underline font element.
       #
       def write_underline(underline)
-        # Handle the underline variants.
-        if underline == 2
-          attributes = [val, 'double']
-        elsif underline == 33
-          attributes = [val, 'singleAccounting']
-        elsif underline == 34
-          attributes = [val, 'doubleAccounting']
-        else
-          attributes = []    # Default to single underline.
-        end
-
+        attributes = underline_attributes(underline)
         @writer.empty_tag('u', attributes)
       end
 
@@ -523,7 +513,7 @@ module Writexlsx
         attributes << 'applyNumberFormat' << 1 if format.num_format_index > 0
 
         # Add applyFont attribute if XF format uses a font element.
-        attributes << 'applyFont' << 1 if format.has_font != 0 && format.font_index > 0
+        attributes << 'applyFont' << 1 if format.font_index > 0
 
         # Add applyFill attribute if XF format uses a fill element.
         attributes << 'applyFill' << 1 if format.fill_index > 0

data/lib/write_xlsx/package/vml.rb

@@ -4,7 +4,7 @@ require 'write_xlsx/utility'
 
 module Writexlsx
   module Package
-    class VML
+    class Vml
 
       include Writexlsx::Utility
 
@@ -16,19 +16,20 @@ module Writexlsx
         @writer.set_xml_writer(filename)
       end
 
-      def assemble_xml_file(data_id, vml_shape_id, comments_data)
+      def assemble_xml_file(worksheet)
         return unless @writer
 
         write_xml_namespace
 
         # Write the o:shapelayout element.
-        write_shapelayout(data_id)
+        write_shapelayout(worksheet.vml_data_id)
 
         # Write the v:shapetype element.
         write_shapetype
 
         z_index = 1
-        comments_data.each do |comment|
+        vml_shape_id = worksheet.vml_shape_id
+        worksheet.comments_array.each do |comment|
           # Write the v:shape element.
           vml_shape_id += 1
           write_shape(vml_shape_id, z_index, comment)
@@ -167,19 +168,10 @@ module Writexlsx
         # Set the shape index.
         id = '_x0000_s' + id.to_s
 
-        # Get the comment parameters
-        row       = comment[0]
-        col       = comment[1]
-        string    = comment[2]
-        author    = comment[3]
-        visible   = comment[4]
-        fillcolor = comment[5]
-        vertices  = comment[6]
-
-        left, top, width, height = pixels_to_points(vertices)
+        left, top, width, height = pixels_to_points(comment.vertices)
 
         # Set the visibility.
-        visibility = 'visible' if visible != 0 && !visible.nil?
+        visibility = 'visible' if comment.visible != 0 && !comment.visible.nil?
 
         left_str    = float_to_str(left)
         top_str     = float_to_str(top)
@@ -207,7 +199,7 @@ module Writexlsx
             'id',          id,
             'type',        type,
             'style',       style,
-            'fillcolor',   fillcolor,
+            'fillcolor',   comment.color,
             'o:insetmode', insetmode
         ]
 
@@ -226,7 +218,7 @@ module Writexlsx
         write_textbox
 
         # Write the x:ClientData element.
-        write_client_data(row, col, visible, vertices)
+        write_client_data(comment)
 
         @writer.end_tag('v:shape')
       end
@@ -297,7 +289,7 @@ module Writexlsx
       #
       # Write the <x:ClientData> element.
       #
-      def write_client_data(row, col, visible, vertices)
+      def write_client_data(comment)
         object_type = 'Note'
 
         attributes = ['ObjectType', object_type]
@@ -311,19 +303,19 @@ module Writexlsx
         write_size_with_cells
 
         # Write the x:Anchor element.
-        write_anchor(vertices)
+        write_anchor(comment.vertices)
 
         # Write the x:AutoFill element.
         write_auto_fill
 
         # Write the x:Row element.
-        write_row(row)
+        write_row(comment.row)
 
         # Write the x:Column element.
-        write_column(col)
+        write_column(comment.col)
 
         # Write the x:Visible element.
-        write_visible if visible != 0 && !visible.nil?
+        write_visible if comment.visible != 0 && !comment.visible.nil?
 
         @writer.end_tag('x:ClientData')
       end

data/lib/write_xlsx/utility.rb

@@ -1,8 +1,13 @@
 # -*- coding: utf-8 -*-
 module Writexlsx
   module Utility
+    ROW_MAX  = 1048576  # :nodoc:
+    COL_MAX  = 16384    # :nodoc:
+    STR_MAX  = 32767    # :nodoc:
+    SHEETNAME_MAX = 31  # :nodoc:
+
     #
-    # xl_rowcol_to_cell($row, $col, $row_absolute, $col_absolute)
+    # xl_rowcol_to_cell($row, col, row_absolute, col_absolute)
     #
     def xl_rowcol_to_cell(row, col, row_absolute = false, col_absolute = false)
       row += 1      # Change from 0-indexed to 1 indexed.
@@ -13,9 +18,9 @@ module Writexlsx
     end
 
     #
-    # Returns: ($row, $col, $row_absolute, $col_absolute)
+    # Returns: [row, col, row_absolute, col_absolute]
     #
-    # The $row_absolute and $col_absolute parameters aren't documented because they
+    # The row_absolute and col_absolute parameters aren't documented because they
     # mainly used internally and aren't very useful to the user.
     #
     def xl_cell_to_rowcol(cell)
@@ -93,7 +98,7 @@ module Writexlsx
     def xml_str
       @writer.string
     end
-    
+
     def self.delete_files(path)
       if FileTest.file?(path)
         File.delete(path)
@@ -109,5 +114,49 @@ module Writexlsx
     def put_deprecate_message(method)
       $stderr.puts("Warning: calling deprecated method #{method}. This method will be removed in a future release.")
     end
+
+    #
+    # Substitute an Excel cell reference in A1 notation for  zero based row and
+    # column values in an argument list.
+    #
+    # Ex: ("A4", "Hello") is converted to (3, 0, "Hello").
+    #
+    def substitute_cellref(cell, *args)       #:nodoc:
+      return [*args] if cell.respond_to?(:coerce) # Numeric
+
+      cell.upcase!
+
+      case cell
+      # Convert a column range: 'A:A' or 'B:G'.
+      # A range such as A:A is equivalent to A1:65536, so add rows as required
+      when /\$?([A-Z]{1,3}):\$?([A-Z]{1,3})/
+        row1, col1 =  xl_cell_to_rowcol($1 + '1')
+        row2, col2 =  xl_cell_to_rowcol($2 + ROW_MAX.to_s)
+        return [row1, col1, row2, col2, *args]
+      # Convert a cell range: 'A1:B7'
+      when /\$?([A-Z]{1,3}\$?\d+):\$?([A-Z]{1,3}\$?\d+)/
+        row1, col1 =  xl_cell_to_rowcol($1)
+        row2, col2 =  xl_cell_to_rowcol($2)
+        return [row1, col1, row2, col2, *args]
+      # Convert a cell reference: 'A1' or 'AD2000'
+      when /\$?([A-Z]{1,3}\$?\d+)/
+        row1, col1 =  xl_cell_to_rowcol($1)
+        return [row1, col1, *args]
+      else
+        raise("Unknown cell reference #{cell}")
+      end
+    end
+
+    def underline_attributes(underline)
+      if underline == 2
+        ['val', 'double']
+      elsif underline == 33
+        ['val', 'singleAccounting']
+      elsif underline == 34
+        ['val', 'doubleAccounting']
+      else
+        []    # Default to single underline.
+      end
+    end
   end
 end