writeexcel 0.3.5 → 0.4.0

data/examples/merge4.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
 
 ###############################################################################
 #

data/examples/merge5.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
 
 ###############################################################################
 #

data/examples/merge6.rb

@@ -1,66 +1,67 @@
-#!/usr/bin/ruby -w
-
-###############################################################################
-#
-# Example of how to use the Spreadsheet::WriteExcel merge_cells() workbook
-# method with Unicode strings.
-#
-#
-# reverse('©'), December 2005, John McNamara, jmcnamara@cpan.org
-#
-# original written in Perl by John McNamara
-# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
-#
-
-require 'writeexcel'
-
-# Create a new workbook and add a worksheet
-workbook  = WriteExcel.new('merge6.xls')
-worksheet = workbook.add_worksheet
-
-# Increase the cell size of the merged cells to highlight the formatting.
-(2..9).each { |i| worksheet.set_row(i, 36) }
-worksheet.set_column('B:D', 25)
-
-# Format for the merged cells.
-format = workbook.add_format(
-           :border      => 6,
-           :bold        => 1,
-           :color       => 'red',
-           :size        => 20,
-           :valign      => 'vcentre',
-           :align       => 'left',
-           :indent      => 1
-  )
-
-###############################################################################
-#
-# Write an Ascii string.
-#
-
-worksheet.merge_range('B3:D4', 'ASCII: A simple string', format)
-
-###############################################################################
-#
-# Write a UTF-16 Unicode string.
-#
-
-# A phrase in Cyrillic encoded as UTF-16BE.
-utf16_str = [
-  '005500540046002d00310036003a0020' <<
-  '042d0442043e002004440440043004370430002004' <<
-  '3d043000200440044304410441043a043e043c0021'
-].pack("H*")
-
-# Note the extra parameter at the end to indicate UTF-16 encoding.
-worksheet.merge_range('B6:D7', utf16_str, format, 1)
-
-###############################################################################
-#
-# Write a UTF-8 Unicode string.
-#
-
-smiley = '☺'  # chr 0x263a in perl
-worksheet.merge_range('B9:D10', "UTF-8: A Unicode smiley #{smiley}", format)
-
-workbook.close
+#!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
+
+###############################################################################
+#
+# Example of how to use the Spreadsheet::WriteExcel merge_cells() workbook
+# method with Unicode strings.
+#
+#
+# reverse('©'), December 2005, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'writeexcel'
+
+# Create a new workbook and add a worksheet
+workbook  = WriteExcel.new('merge6.xls')
+worksheet = workbook.add_worksheet
+
+# Increase the cell size of the merged cells to highlight the formatting.
+(2..9).each { |i| worksheet.set_row(i, 36) }
+worksheet.set_column('B:D', 25)
+
+# Format for the merged cells.
+format = workbook.add_format(
+           :border      => 6,
+           :bold        => 1,
+           :color       => 'red',
+           :size        => 20,
+           :valign      => 'vcentre',
+           :align       => 'left',
+           :indent      => 1
+  )
+
+###############################################################################
+#
+# Write an Ascii string.
+#
+
+worksheet.merge_range('B3:D4', 'ASCII: A simple string', format)
+
+###############################################################################
+#
+# Write a UTF-16 Unicode string.
+#
+
+# A phrase in Cyrillic encoded as UTF-16BE.
+utf16_str = [
+  '005500540046002d00310036003a0020' <<
+  '042d0442043e002004440440043004370430002004' <<
+  '3d043000200440044304410441043a043e043c0021'
+].pack("H*")
+
+# Note the extra parameter at the end to indicate UTF-16 encoding.
+worksheet.merge_range('B6:D7', utf16_str, format, 1)
+
+###############################################################################
+#
+# Write a UTF-8 Unicode string.
+#
+
+smiley = '☺'  # chr 0x263a in perl
+worksheet.merge_range('B9:D10', "UTF-8: A Unicode smiley #{smiley}", format)
+
+workbook.close

data/examples/outline.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
 
 ###############################################################################
 #

data/examples/outline_collapsed.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
 
 ###############################################################################
 #

data/examples/panes.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
 
 #######################################################################
 #

data/examples/properties.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
 
 ##############################################################################
 #

data/examples/properties_jp.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
 
 ##############################################################################
 #

data/examples/protection.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
   #!/usr/bin/ruby -w
 
 ########################################################################

data/examples/regions.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
 
 ###############################################################################
 #

data/examples/repeat.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
   #!/usr/bin/ruby -w
 
 ######################################################################

data/examples/right_to_left.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
 
 #######################################################################
 #

data/examples/row_wrap.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
 
 ##############################################################################
 #

data/examples/stats.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
 
 ###############################################################################
 #

data/examples/stocks.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
   #!/usr/bin/ruby -w
 
 ###############################################################################

data/examples/tab_colors.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
 
 #######################################################################
 #

data/examples/write_arrays.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
 
 #######################################################################
 #

data/lib/writeexcel.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 ###############################################################################
 #
 # WriteExcel.
@@ -980,7 +981,8 @@
 #     6. Ensure that the function is in the above table.
 #
 # If you go through steps 1-6 and you still have a problem, mail me.
-# Improving performance when working with formulas
+#
+# ===Improving performance when working with formulas
 #
 # Writing a large number of formulas with Spreadsheet::WriteExcel can be slow.
 # This is due to the fact that each formula has to be parsed and with the
@@ -1130,4 +1132,7 @@
 #       12 until another chart with the title set is viewed.
 #
 class WriteExcel < Workbook
+  if RUBY_VERSION < '1.9'
+    $KCODE = 'u'
+  end
 end

data/lib/writeexcel/biffwriter.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 #
 # BIFFwriter - An abstract base class for Excel workbooks and worksheets.
 #
@@ -35,7 +36,7 @@ def initialize
     # Open a tmp file to store the majority of the Worksheet data. If this fails,
     # for example due to write permissions, store the data in memory. This can be
     # slow for large files.
-    @filehandle = Tempfile.new('spreadsheetwriteexcel')
+    @filehandle = Tempfile.new('writeexcel')
     @filehandle.binmode
 
     # failed. store temporary data in memory.
@@ -77,14 +78,14 @@ def set_byte_order
   #
   def prepend(*args)
     d = args.join
-    d = add_continue(d) if d.length > @limit
+    d = add_continue(d) if d.bytesize > @limit
 
-    @datasize += d.length
+    @datasize += d.bytesize
     @data      = d + @data
 
     print "prepend\n" if defined?($debug)
     print d.unpack('C*').map! {|c| sprintf("%02X", c) }.join(' ') + "\n\n" if defined?($debug)
-    return d
+    d
   end
 
   ###############################################################################
@@ -94,20 +95,20 @@ def prepend(*args)
   # General storage function
   #
   def append(*args)
-    d = args.join
+    d = args.collect{ |a| a.dup.force_encoding('ASCII-8BIT') }.join
     # Add CONTINUE records if necessary
-    d = add_continue(d) if d.length > @limit
+    d = add_continue(d) if d.bytesize > @limit
     if @using_tmpfile
       @filehandle.write d
-      @datasize += d.length
+      @datasize += d.bytesize
     else
-      @datasize += d.length
+      @datasize += d.bytesize
       @data      = @data + d
     end
 
     print "append\n" if defined?($debug)
     print d.unpack('C*').map! {|c| sprintf("%02X", c) }.join(' ') + "\n\n" if defined?($debug)
-    return d
+    d
   end
 
   ###############################################################################
@@ -137,7 +138,7 @@ def get_data
     end
 
     # No data to return
-    return nil
+    nil
   end
 
   ###############################################################################
@@ -212,7 +213,7 @@ def add_continue(data)
 
     # in perl
     #  $tmp = substr($data, 0, $limit, "");
-    if data.length > @limit
+    if data.bytesize > @limit
       tmp = data[0, @limit]
       data[0, @limit] = ''
     else
@@ -223,17 +224,15 @@ def add_continue(data)
     tmp[2, 2] = [@limit-4].pack('v')
 
     # Strip out chunks of 2080/8224 bytes +4 for the header.
-    while (data.length > @limit)
+    while (data.bytesize > @limit)
       header  = [record, @limit].pack("vv")
-      tmp     = tmp + header + data[0, @limit]
+      tmp     += header + data[0, @limit]
       data[0, @limit] = ''
     end
 
     # Mop up the last of the data
-    header  = [record, data.length].pack("vv")
-    tmp     = tmp + header + data
-
-    return tmp
+    header  = [record, data.bytesize].pack("vv")
+    tmp     += header + data
   end
 
   ###############################################################################
@@ -251,14 +250,12 @@ def add_continue(data)
   # Returns the packed record.
   #
   def add_mso_generic(type, version, instance, data, length = nil)
-    length  = length.nil? ? data.length : length
+    length  = length.nil? ? data.bytesize : length
 
     # The header contains version and instance info packed into 2 bytes.
     header  = version | (instance << 4)
 
     record  = [header, type, length].pack('vvV') + data
-
-    return record
   end
 
   def not_using_tmpfile
@@ -270,4 +267,8 @@ def not_using_tmpfile
   def clear_data_for_test # :nodoc:
     @data = ''
   end
+
+  def cleanup # :nodoc:
+    @filehandle.close(true) if @filehandle
+  end
 end

data/lib/writeexcel/chart.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 ###############################################################################
 #
 # Chart - A writer class for Excel Charts.
@@ -48,7 +49,8 @@
 # Chart - A writer class for Excel Charts.
 #
 class Chart < Worksheet
-  NonAscii = /[^!"#\$%&'\(\)\*\+,\-\.\/\:\;<=>\?@0-9A-Za-z_\[\\\]^` ~\0\n]/  # :nodoc:
+  require 'writeexcel/helper'
+  private :convert_to_ascii_if_ascii
 
   ###############################################################################
   #
@@ -639,10 +641,10 @@ def parse_series_formula(formula)  # :nodoc:
     formula = parser.parse_tokens(tokens)
 
     # Return formula for a single cell as used by title and series name.
-    return formula if formula[0] == 0x3A
+    return formula if formula.ord == 0x3A
 
     # Extract the range from the parse formula.
-    if formula[0] == 0x3B
+    if formula.ord == 0x3B
         ptg, ext_ref, row_1, row_2, col_1, col_2 = formula.unpack('Cv5')
 
         # TODO. Remove high bit on relative references.
@@ -666,16 +668,19 @@ def encode_utf16(str, encoding = 0)  # :nodoc:
     # Return if encoding is set, i.e., string has been manually encoded.
     #return ( undef, undef ) if $string == 1;
 
-    # Handle utf8 strings in perl 5.8.
-    if string =~ NonAscii
+    string = convert_to_ascii_if_ascii(string)
+
+    # Handle utf8 strings.
+    if string.encoding == Encoding::UTF_8
       string = NKF.nkf('-w16B0 -m0 -W', string)
+      string.force_encoding('UTF-16BE')
       encoding = 1
     end
 
     # Chart strings are limited to 255 characters.
     limit = encoding != 0 ? 255 * 2 : 255
 
-    if string.length >= limit
+    if string.bytesize >= limit
       # truncate the string and raise a warning.
       string = string[0, limit]
     end
@@ -733,7 +738,7 @@ def get_color_indices(color)   # :nodoc:
     end
 
     rgb = get_color_rbg(index)
-    return [index, rgb]
+    [index, rgb]
   end
 
   ###############################################################################
@@ -1255,7 +1260,9 @@ def store_ai(id, type, formula, format_index = 0)   # :nodoc:
     # format_index            # Num format index.
     grbit        = 0x0000     # Option flags.
 
-    formula_length  = formula.length
+    formula = convert_to_ascii_if_ascii(formula)
+
+    formula_length  = formula.bytesize
     length += formula_length
 
     header = [record, length].pack('vv')
@@ -1264,7 +1271,11 @@ def store_ai(id, type, formula, format_index = 0)   # :nodoc:
     data  += [grbit].pack('v')
     data  += [format_index].pack('v')
     data  += [formula_length].pack('v')
-    data  += formula[0].kind_of?(String) ? formula[0] : formula
+    if formula.kind_of?(Array)
+      data += formula[0].encode('BINARY')
+    else
+      data += formula.encode('BINARY') unless formula.nil?
+    end
 
     print "sheet #{@name} : #{__FILE__}(#{__LINE__}) \n" if defined?($debug)
     append(header, data)
@@ -1771,7 +1782,7 @@ def store_lineformat(rgb, lns, we, grbit, index)  # :nodoc:
 
     print "sheet #{@name} : #{__FILE__}(#{__LINE__}) \n" if defined?($debug)
     append(header, data)
- end
+  end
 
   ###############################################################################
   #
@@ -1980,12 +1991,14 @@ def store_series(category_count, value_count)  # :nodoc:
   # Write the SERIESTEXT chart BIFF record.
   #
   def store_seriestext(str, encoding)  # :nodoc:
+    str = convert_to_ascii_if_ascii(str)
+
     record   = 0x100D          # Record identifier.
     length   = 0x0000          # Number of bytes to follow.
     id       = 0x0000          # Text id.
     # str                      # Text.
     # encoding                 # String encoding.
-    cch      = str.length      # String length.
+    cch      = str.bytesize      # String length.
 
     encoding ||= 0
 
@@ -1995,7 +2008,7 @@ def store_seriestext(str, encoding)  # :nodoc:
     # Change the UTF-16 name from BE to LE
     str = str.unpack('v*').pack('n*') if encoding != 0
 
-    length = 4 + str.length
+    length = 4 + str.bytesize
 
     header = [record, length].pack('vv')
     data  = [id].pack('v')