write_xlsx 0.75.0 → 0.76.0

data/lib/write_xlsx/worksheet/hyperlink.rb

@@ -5,22 +5,19 @@ module Writexlsx
     class Hyperlink   # :nodoc:
       include Writexlsx::Utility
 
-      attr_reader :url, :link_type, :str, :url_str
-      attr_accessor :tip, :display
-
-      def self.factory(url, str = nil)
-        if url =~ /^internal:/
-          InternalHyperlink.new(url, str)
-        elsif url =~ /^external:/
-          ExternalHyperlink.new(url, str)
+      attr_reader :str, :tip
+
+      def self.factory(url, str = nil, tip = nil)
+        if url =~ /^internal:(.+)/
+          InternalHyperlink.new($~[1], str, tip)
+        elsif url =~ /^external:(.+)/
+          ExternalHyperlink.new($~[1], str, tip)
         else
-          new(url, str)
+          new(url, str, tip)
         end
       end
 
-      def initialize(url, str = nil)
-        @link_type = 1
-
+      def initialize(url, str, tip)
         # The displayed string defaults to the url string.
         str ||= url.dup
 
@@ -51,38 +48,35 @@ module Writexlsx
         @url       = url
         @str       = str
         @url_str   = nil
+        @tip       = tip
       end
 
-      def write_external_attributes(row, col, id)
+      def attributes(row, col, id)
         ref = xl_rowcol_to_cell(row, col)
 
-        attributes = [ ['ref', ref] ]
-        attributes << r_id_attributes(id)
+        attr = [ ['ref', ref] ]
+        attr << r_id_attributes(id)
 
-        attributes << ['location', url_str] if url_str
-        attributes << ['display',  display] if display
-        attributes << ['tooltip',  tip]     if tip
-        attributes
+        attr << ['location', @url_str] if @url_str
+        attr << ['display',  @display] if @display
+        attr << ['tooltip',  @tip]     if @tip
+        attr
       end
 
-      def write_internal_attributes(row, col)
-        ref = xl_rowcol_to_cell(row, col)
-
-        attributes = [
-                      ['ref', ref],
-                      ['location', url]
-                     ]
+      def external_hyper_link
+        ['/hyperlink', @url, 'External']
+      end
 
-        attributes << ['tooltip', tip] if tip
-        attributes << ['display', str]
+      def display_on
+        @display = @url_str
       end
     end
 
     class InternalHyperlink < Hyperlink
-      def initialize(url, str)
-        @link_type = 2
-        @url = url.sub(/^internal:/, '')
+      undef external_hyper_link
 
+      def initialize(url, str, tip)
+        @url = url
         # The displayed string defaults to the url string.
         str ||= @url.dup
 
@@ -96,16 +90,23 @@ module Writexlsx
         if @url.bytesize > 255
           raise "URL '#{@url}' > 255 characters, it exceeds Excel's limit for URLS."
         end
+
+        @tip = tip
       end
-    end
 
-    class ExternalHyperlink < Hyperlink
-      def initialize(url, str = nil)
-        @link_type = 1
+      def attributes(row, col, dummy = nil)
+        attr = [
+                ['ref', xl_rowcol_to_cell(row, col)],
+                ['location', @url]
+               ]
 
-        # Remove the URI scheme from internal links.
-        url = url.sub(/^external:/, '')
+        attr << ['tooltip', @tip] if @tip
+        attr << ['display', @str]
+      end
+    end
 
+    class ExternalHyperlink < Hyperlink
+      def initialize(url, str, tip)
         # The displayed string defaults to the url string.
         str ||= url.dup
 
@@ -138,6 +139,7 @@ module Writexlsx
         @url       = url
         @str       = str
         @url_str   = url_str
+        @tip       = tip
       end
     end
   end

data/lib/write_xlsx/worksheet.rb

@@ -299,9 +299,10 @@ module Writexlsx
       @workbook = workbook
       @index = index
       @name = name
-      @colinfo = []
+      @colinfo = {}
       @cell_data_table = {}
       @excel_version = 2007
+      @palette = workbook.palette
 
       @page_setup = PageSetup.new
 
@@ -335,7 +336,6 @@ module Writexlsx
       @last_shape_id          = 1
       @rel_count              = 0
       @hlink_count            = 0
-      @hlink_refs             = []
       @external_hyper_links   = []
       @external_drawing_links = []
       @external_comment_links = []
@@ -730,8 +730,8 @@ module Writexlsx
 
       @outline_col_level = level if level > @outline_col_level
 
-      # Store the column data.
-      @colinfo << [firstcol, lastcol, width, format, hidden, level, collapsed]
+      # Store the column data based on the first column. Padded for sorting.
+      @colinfo[sprintf("%05d", firstcol)] = [firstcol, lastcol, width, format, hidden, level, collapsed]
 
       # Store the column change to allow optimisations.
       @col_size_changed = 1
@@ -777,9 +777,7 @@ module Writexlsx
       row_first, col_first, row_last, col_last = row_col_notation(args)
       active_cell = xl_rowcol_to_cell(row_first, col_first)
 
-      if row_last.nil?   # Single cell selection.
-        sqref = active_cell
-      else               # Range selection.
+      if row_last  # Range selection.
         # Swap last row/col for first row/col as necessary
         row_first, row_last = row_last, row_first if row_first > row_last
         col_first, col_last = col_last, col_first if col_first > col_last
@@ -790,6 +788,8 @@ module Writexlsx
         else
           sqref = xl_range(row_first, row_last, col_first, col_last)
         end
+      else          # Single cell selection.
+        sqref = active_cell
       end
 
       # Selection isn't set for cell A1.
@@ -941,7 +941,7 @@ module Writexlsx
     # See the tab_colors.rb program in the examples directory of the distro.
     #
     def tab_color=(color)
-      @tab_color = Colors.new.get_color(color)
+      @tab_color = Colors.new.color(color)
     end
 
     # This method is deprecated. use tab_color=().
@@ -2289,7 +2289,7 @@ module Writexlsx
       check_dimensions(row, col)
       store_row_col_max_min_values(row, col)
 
-      store_data_to_table(BlankCellData.new(self, row, col,  nil, xf))
+      store_data_to_table(BlankCellData.new(self, row, col, xf))
     end
 
     #
@@ -2470,7 +2470,7 @@ module Writexlsx
 
     #
     # :call-seq:
-    #   write_url(row, column, url [ , format, label ] )
+    #   write_url(row, column, url [ , format, label, tip ] )
     #
     # Write a hyperlink to a URL in the cell specified by +row+ and +column+.
     # The hyperlink is comprised of two elements: the visible label and
@@ -2558,22 +2558,15 @@ module Writexlsx
       check_dimensions(row, col)
       store_row_col_max_min_values(row, col)
 
-      hyperlink = Hyperlink.factory(url, str)
-      hyperlink.tip = tip
+      hyperlink = Hyperlink.factory(url, str, tip)
+      store_hyperlink(row, col, hyperlink)
 
-      @hlink_count += 1
-
-      if @hlink_count > 65_530
-        raise "URL '#{hyperlink.url}' added but number of URLS is over Excel's limit of 65,530 URLS per worksheet."
+      if hyperlinks_count > 65_530
+        raise "URL '#{url}' added but number of URLS is over Excel's limit of 65,530 URLS per worksheet."
       end
 
       # Write the hyperlink string.
       write_string(row, col, hyperlink.str, xf)
-
-      # Store the hyperlink data in a separate structure.
-      @hyperlinks      ||= {}
-      @hyperlinks[row] ||= {}
-      @hyperlinks[row][col] = hyperlink
     end
 
     #
@@ -3046,6 +3039,7 @@ module Writexlsx
     # worksheet method, see above.
     #
     def set_row(*args)
+      return unless args[0]
       row = args[0]
       height = args[1] || @default_height
       xf     = args[2]
@@ -3053,8 +3047,6 @@ module Writexlsx
       level  = args[4] || 0
       collapsed = args[5] || 0
 
-      return if row.nil?
-
       # Get the default row height.
       default_height = @default_row_height
 
@@ -5692,19 +5684,12 @@ module Writexlsx
     # Convert from an Excel internal colour index to a XML style #RRGGBB index
     # based on the default or user defined values in the Workbook palette.
     #
-    def get_palette_color(index) #:nodoc:
+    def palette_color(index) #:nodoc:
       if index =~ /^#([0-9A-F]{6})$/i
-        return "FF#{$~[1]}"
+        "FF#{$1.upcase}"
+      else
+        "FF#{super(index)}"
       end
-
-      # Adjust the colour index.
-      index -= 8
-
-      # Palette is passed in from the Workbook class.
-      rgb = @workbook.palette[index]
-
-      # TODO Add the alpha part to the RGB.
-      sprintf("FF%02X%02X%02X", *rgb[0, 3])
     end
 
     def buttons_data  # :nodoc:
@@ -5769,6 +5754,16 @@ module Writexlsx
 
     private
 
+    def hyperlinks_count
+      @hyperlinks.keys.inject(0) { |s, n| s += @hyperlinks[n].keys.size }
+    end
+
+    def store_hyperlink(row, col, hyperlink)
+      @hyperlinks      ||= {}
+      @hyperlinks[row] ||= {}
+      @hyperlinks[row][col] = hyperlink
+    end
+
     def cell_format_of_rich_string(rich_strings)
       # If the last arg is a format we use it as the cell format.
       if rich_strings[-1].respond_to?(:xf_index)
@@ -6526,7 +6521,7 @@ module Writexlsx
       return if @colinfo.empty?
 
       @writer.tag_elements('cols') do
-        @colinfo.each {|col_info| write_col_info(col_info) }
+        @colinfo.keys.sort.each {|col| write_col_info(@colinfo[col]) }
       end
     end
 
@@ -6551,9 +6546,7 @@ module Writexlsx
       custom_width = false if width.nil? && hidden == 0
       custom_width = false if width == 8.43
 
-      if width.nil?
-        width = hidden == 0 ? 8.43 : 0
-       end
+      width = hidden == 0 ? 8.43 : 0 unless width
 
       # Convert column width from user units to character width.
       if width && width < 1
@@ -6676,7 +6669,7 @@ module Writexlsx
       return if @panes.empty?
 
       if @panes[4] == 2
-        write_split_panes(*(@panes))
+        write_split_panes
       else
         write_freeze_panes(*(@panes))
       end
@@ -6724,7 +6717,8 @@ module Writexlsx
     #
     # See also, implementers note for split_panes().
     #
-    def write_split_panes(row, col, top_row, left_col, type) #:nodoc:
+    def write_split_panes #:nodoc:
+      row, col, top_row, left_col = @panes
       has_selection = false
       y_split = row
       x_split = col
@@ -7053,7 +7047,7 @@ module Writexlsx
     #
     def write_hyperlinks #:nodoc:
       return unless @hyperlinks
-
+      hlink_attributes = []
       @hyperlinks.keys.sort.each do |row_num|
         # Sort the hyperlinks into column order.
         col_nums = @hyperlinks[row_num].keys.sort
@@ -7064,56 +7058,34 @@ module Writexlsx
 
           # If the cell isn't a string then we have to add the url as
           # the string to display
-          if  ptrue?(@cell_data_table)          &&
+          if ptrue?(@cell_data_table)          &&
               ptrue?(@cell_data_table[row_num]) &&
               ptrue?(@cell_data_table[row_num][col_num])
             if @cell_data_table[row_num][col_num].display_url_string?
-              link.display = link.url_str
+              link.display_on
             end
           end
 
-          if link.link_type == 1
+          if link.respond_to?(:external_hyper_link)
             # External link with rel file relationship.
             @rel_count += 1
-            @hlink_refs << [link, row_num, col_num, @rel_count]
             # Links for use by the packager.
-            @external_hyper_links << ['/hyperlink', link.url, 'External']
-          else
-            # Internal link with rel file relationship.
-            @hlink_refs << [link, row_num, col_num]
+            @external_hyper_links << link.external_hyper_link
           end
+          hlink_attributes << link.attributes(row_num, col_num, @rel_count)
         end
       end
 
-      return if @hlink_refs.empty?
+      return if hlink_attributes.empty?
 
       # Write the hyperlink elements.
       @writer.tag_elements('hyperlinks') do
-        @hlink_refs.each do |aref|
-          case aref[0].link_type
-          when 1
-            write_hyperlink_external(*aref)
-          when 2
-            write_hyperlink_internal(*aref)
-          end
+        hlink_attributes.each do |attributes|
+          @writer.empty_tag('hyperlink', attributes)
         end
       end
     end
 
-    #
-    # Write the <hyperlink> element for external links.
-    #
-    def write_hyperlink_external(link, row, col, id)  # :nodoc:
-      @writer.empty_tag('hyperlink', link.write_external_attributes(row, col, id))
-    end
-
-    #
-    # Write the <hyperlink> element for internal links.
-    #
-    def write_hyperlink_internal(link, row, col)  #:nodoc:
-      @writer.empty_tag('hyperlink', link.write_internal_attributes(row, col))
-    end
-
     #
     # Write the <tabColor> element.
     #
@@ -7122,7 +7094,7 @@ module Writexlsx
 
       @writer.empty_tag('tabColor',
                         [
-                         ['rgb', get_palette_color(@tab_color)]
+                         ['rgb', palette_color(@tab_color)]
                         ])
     end
 

data/lib/write_xlsx/zip_file_utils.rb

@@ -0,0 +1,99 @@
+# -*- coding: utf-8 -*-
+#
+# from http://d.hatena.ne.jp/alunko/20071021
+#
+require 'kconv'
+require 'zip/zipfilesystem'
+require 'fileutils'
+
+module ZipFileUtils
+
+  # src  file or directory
+  # dest  zip filename
+  # options :fs_encoding=[UTF-8,Shift_JIS,EUC-JP]
+  def self.zip(src, dest, options = {})
+    src = File.expand_path(src)
+    dest = File.expand_path(dest)
+    File.unlink(dest) if File.exist?(dest)
+    Zip::ZipFile.open(dest, Zip::ZipFile::CREATE) {|zf|
+      if(File.file?(src))
+        zf.add(encode_path(File.basename(src), options[:fs_encoding]), src)
+        break
+      else
+        each_dir_for(src){ |path|
+          if File.file?(path)
+            zf.add(encode_path(relative(path, src), options[:fs_encoding]), path)
+          elsif File.directory?(path)
+            zf.mkdir(encode_path(relative(path, src), options[:fs_encoding]))
+          end
+        }
+      end
+    }
+    FileUtils.chmod(0644, dest)
+  end
+
+  # src  zip filename
+  # dest  destination directory
+  # options :fs_encoding=[UTF-8,Shift_JIS,EUC-JP]
+  def self.unzip(src, dest, options = {})
+    FileUtils.makedirs(dest)
+    Zip::ZipInputStream.open(src) do |is|
+      loop do
+        entry = is.get_next_entry()
+        break unless entry
+        dir = File.dirname(entry.name)
+        FileUtils.makedirs(dest+ '/' + dir)
+        path = encode_path(dest + '/' + entry.name, options[:fs_encoding])
+        if(entry.file?())
+          File.open(path, File::CREAT|File::WRONLY|File::BINARY) do |w|
+            w.puts(is.read())
+          end
+        else
+          FileUtils.makedirs(path)
+        end
+      end
+    end
+  end
+
+  private
+
+  def self.each_dir_for(dir_path, &block)
+    dir = Dir.open(dir_path)
+    each_file_for(dir_path){ |file_path|
+      yield(file_path)
+    }
+  end
+
+  def self.each_file_for(path, &block)
+    if File.file?(path)
+      yield(path)
+      return true
+    end
+    dir = Dir.open(path)
+    file_exist = false
+    dir.each(){ |file|
+      next if file == '.' || file == '..'
+      file_exist = true if each_file_for(path + "/" + file, &block)
+    }
+    yield(path) unless file_exist
+    return file_exist
+  end
+
+  def self.relative(path, base_dir)
+    path[base_dir.length() + 1 .. path.length()] if path.index(base_dir) == 0
+  end
+
+  def self.encode_path(path, encode_s)
+    return path unless encode_s
+    case(encode_s)
+    when('UTF-8')
+      return path.toutf8()
+    when('Shift_JIS')
+      return path.tosjis()
+    when('EUC-JP')
+      return path.toeuc()
+    else
+      return path
+    end
+  end
+end

data/test/chart/test_add_series.rb

@@ -8,7 +8,7 @@ class TestAddSeries < Test::Unit::TestCase
   end
 
   def test_add_series_only_values
-    series = Series.new(@chart)
+    series = Writexlsx::Chart::Series.new(@chart)
     series.instance_variable_set(:@categories, nil)
     series.instance_variable_set(:@values, '=Sheet1!$A$1:$A$5')
     series.instance_variable_set(:@name, nil)
@@ -40,7 +40,7 @@ class TestAddSeries < Test::Unit::TestCase
   end
 
   def test_add_series_with_categories_and_values
-    series = Series.new(@chart)
+    series = Writexlsx::Chart::Series.new(@chart)
     series.instance_variable_set(:@categories, '=Sheet1!$A$1:$A$5')
     series.instance_variable_set(:@values, '=Sheet1!$B$1:$B$5')
     series.instance_variable_set(:@name, 'Text')
@@ -75,7 +75,7 @@ class TestAddSeries < Test::Unit::TestCase
   end
 
   def test_add_series_only_values_checked_by_array
-    series = Series.new(@chart)
+    series = Writexlsx::Chart::Series.new(@chart)
     series.instance_variable_set(:@categories, nil)
     series.instance_variable_set(:@values, '=Sheet1!$A$1:$A$5')
     series.instance_variable_set(:@name, nil)
@@ -106,7 +106,7 @@ class TestAddSeries < Test::Unit::TestCase
   end
 
   def test_add_series_both_checked_by_array
-    series = Series.new(@chart)
+    series = Writexlsx::Chart::Series.new(@chart)
     series.instance_variable_set(:@categories, '=Sheet1!$A$1:$A$5')
     series.instance_variable_set(:@values, '=Sheet1!$B$1:$B$5')
     series.instance_variable_set(:@name, 'Text')
@@ -141,7 +141,7 @@ class TestAddSeries < Test::Unit::TestCase
   end
 
   def test_add_series_secondary_axis
-    series = Series.new(@chart)
+    series = Writexlsx::Chart::Series.new(@chart)
     series.instance_variable_set(:@categories,  '=Sheet1!$A$1:$A$5')
     series.instance_variable_set(:@values, '=Sheet1!$B$1:$B$5')
     series.instance_variable_set(:@name, 'Text')

data/test/chart/test_write_d_lbls.rb

@@ -5,7 +5,7 @@ require 'write_xlsx/chart'
 class TestWriteDLbls < Test::Unit::TestCase
   def setup
     @chart = Writexlsx::Chart.new('Pie')
-    @series = Series.new(@chart)
+    @series = Writexlsx::Chart::Series.new(@chart)
   end
 
   def test_write_d_lbls_value_only

data/test/chart/test_write_major_gridlines.rb

@@ -9,7 +9,7 @@ class TestWriteMajorGridlines < Test::Unit::TestCase
 
   def test_write_major_gridlines
     expected = '<c:majorGridlines/>'
-    result = @chart.__send__('write_major_gridlines', {:_visible => 1})
+    result = @chart.__send__('write_major_gridlines', Writexlsx::Chart::Gridline.new(:_visible => 1))
     assert_equal(expected, result)
   end
 end

data/test/chart/test_write_marker.rb

@@ -9,7 +9,7 @@ class TestWriteMarker < Test::Unit::TestCase
 
   def test_write_marker
     expected = '<c:marker><c:symbol val="none"/></c:marker>'
-    @chart.instance_variable_set(:@default_marker, { :type => 'none'})
+    @chart.instance_variable_set(:@default_marker, Writexlsx::Chart::Marker.new(:type => 'none'))
     @chart.__send__('write_marker')
     result = @chart.instance_variable_get(:@writer).string
     assert_equal(expected, result)

data/test/chart/test_write_number_format.rb

@@ -32,7 +32,7 @@ class TestWriteNumberFormat < Test::Unit::TestCase
     axis.num_format = 'General'
     axis.defaults   = { :num_format => 'General' }
 
-    expected = ''
+    expected = nil
     result = @chart.__send__('write_cat_number_format', axis)
     assert_equal(expected, result)
   end

data/test/helper.rb

@@ -68,7 +68,8 @@ class Test::Unit::TestCase
 
   def entrys(xlsx)
     result = []
-    Zip::File.foreach(xlsx) { |entry| result << entry }
+    ruby_19 { Zip::File.foreach(xlsx) { |entry| result << entry } } ||
+    ruby_18 { Zip::ZipFile.foreach(xlsx) { |entry| result << entry } }
     result
   end
 
@@ -100,11 +101,13 @@ class Test::Unit::TestCase
         got_xml_str = got_str.gsub(%r!(\S)/>!, '\1 />')
         #        exp_xml_str = exp_members[i].get_input_stream.read.gsub(%r!(\S)/>!, '\1 />')
         exp_str = exp_members[i].get_input_stream.read
-        exp_str.force_encoding("ASCII-8BIT") if got_str.encoding == Encoding::ASCII_8BIT
+        ruby_19 do
+          exp_str.force_encoding("ASCII-8BIT") if got_str.encoding == Encoding::ASCII_8BIT
+        end
         exp_xml_str = exp_str.gsub(%r!(\S)/>!, '\1 />')
       rescue
-        p got_str.encoding
-        p exp_str.encoding
+        p ruby_19 { got_str.encoding } || ruby_18 { got_str }
+        p ruby_19 { exp_str.encoding } || ruby_18 { exp_str }
       end
       # Remove dates and user specific data from the core.xml data.
       if exp_members[i].name == 'docProps/core.xml'

data/test/regression/klt.csv

@@ -0,0 +1,4 @@
+����� ������� ������ ������
+����� ����,��� ����,�� ����,���� ����,���� ����,��,���� ������,����,����,����,�����,����
+01/11/2012,09:04:20,_����                                             ,      131, 39977777,�����������         ,00171044973,                    ,                    ,�� �����                 ,                         ,����� ����/����� �� ���� ������
+01/11/2012,09:04:24,_����                                             ,      131, 36888865,�������             ,00171081635,���� ������         ,���� ������         ,�� �����                 ,                         ,

data/test/regression/test_chart_column07.rb

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartColumn07 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_chart_column07
+    @xlsx = 'chart_column07.xlsx'
+    workbook  = WriteXLSX.new(@xlsx)
+    worksheet = workbook.add_worksheet
+    chart     = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # For testing, copy the randomly generated axis ids in the target xlsx file.
+    chart.instance_variable_set(:@axis_ids, [68810240, 68811776])
+
+    data = [
+            [ 1, 2, 3, 4,  5 ],
+            [ 2, 4, 6, 8,  10 ],
+            [ 3, 6, 9, 12, 15 ]
+           ]
+
+    worksheet.write('A1', data)
+
+    chart.add_series(
+                     :values      => '=(Sheet1!$A$1:$A$2,Sheet1!$A$4:$A$5)',
+                     :values_data => [1, 2, 4, 5]
+                     )
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_xlsx_for_regression(File.join(@regression_output, @xlsx),
+                                @xlsx,
+                                nil,
+                                nil
+                                )
+  end
+end