spreadsheet 1.1.3 → 1.3.1

data/lib/spreadsheet/excel/writer/worksheet.rb

@@ -20,7 +20,7 @@ class Worksheet
   def initialize workbook, worksheet
     @workbook = workbook
     @worksheet = worksheet
-    @io = StringIO.new ''
+    @io = StringIO.new ''.dup
     @biff_version = 0x0600
     @bof = 0x0809
     @build_id = 3515
@@ -243,84 +243,6 @@ class Worksheet
     end
     write_multiples row, first_idx, multiples if multiples
   end
-  def write_changes reader, endpos, sst_status
-
-    ## FIXME this is not smart solution to update outline_level.
-    #        without this process, outlines in row disappear in MS Excel.
-    @worksheet.row_count.times do |i|
-      if @worksheet.row(i).outline_level > 0
-        @worksheet.row(i).outline_level = @worksheet.row(i).outline_level
-      end
-    end
-
-    reader.seek @worksheet.offset
-    blocks = row_blocks
-    lastpos = reader.pos
-    offsets = {}
-    row_offsets = []
-    changes = @worksheet.changes
-    @worksheet.offsets.each do |key, pair|
-      if changes.include?(key) \
-        || (sst_status == :complete_update && key.is_a?(Integer))
-        offsets.store pair, key
-      end
-    end
-    ## FIXME it may be smarter to simply write all rowblocks, instead of doing a
-    #        song-and-dance routine for every row...
-    work = offsets.invert
-    work.each do |key, (pos, len)|
-      case key
-      when Integer
-        row_offsets.push [key, [pos, len]]
-      when :dimensions
-        row_offsets.push [-1, [pos, len]]
-      end
-    end
-    row_offsets.sort!
-    row_offsets.reverse!
-    control = changes.size
-    @worksheet.each do |row|
-      key = row.idx
-      if changes.include?(key) && !work.include?(key)
-        row, pair = row_offsets.find do |idx, _| idx <= key end
-        work.store key, pair
-      end
-    end
-    if changes.size > control
-      warn <<-EOS
-Your Worksheet was modified while it was being written. This should not happen.
-Please contact the author (hannes dot wyss at gmail dot com) with a sample file
-and minimal code that generates this warning. Thanks!
-      EOS
-    end
-    work = work.sort_by do |key, (pos, _)|
-      [pos, key.is_a?(Integer) ? key : -1]
-    end
-    work.each do |key, (pos, len)|
-      @io.write reader.read(pos - lastpos) if pos > lastpos
-      if key.is_a?(Integer)
-        if block = blocks.find do |rows| rows.any? do |row| row.idx == key end end
-          write_rowblock block
-          blocks.delete block
-        end
-      else
-        send "write_#{key}"
-      end
-      lastpos = pos + len
-      reader.seek lastpos
-    end
-
-    # Necessary for outline (grouping) and hiding functions
-    # but these below are not necessary to run
-    # if [Row|Column]#hidden? = false and [Row|Column]#outline_level == 0
-    write_merged_cells
-    write_pagesetup
-    write_margins
-    write_colinfos
-    write_guts
-
-    @io.write reader.read(endpos - lastpos)
-  end
   def write_colinfo bunch
     col = bunch.first
     width = col.width.to_f * 256
@@ -642,7 +564,7 @@ and minimal code that generates this warning. Thanks!
   ##
   # Write multiple consecutive cells with RK values (see #write_rk)
   def write_mulrk row, idx, multiples
-    fmt = 'v2'
+    fmt = ['v2']
     data = [
       row.idx, # Index to row
       idx, # Index to first column (fc)
@@ -655,7 +577,7 @@ and minimal code that generates this warning. Thanks!
     end
     # Index to last column (lc)
     data.push idx + multiples.size - 1
-    write_op opcode(:mulrk), data.pack(fmt << 'v')
+    write_op opcode(:mulrk), data.pack((fmt << 'v').join)
   end
   def write_multiples row, idx, multiples
     case multiples.last

data/lib/spreadsheet/excel.rb

@@ -1,11 +1,5 @@
 require 'spreadsheet'
 
-warn <<-EOS
-[DEPRECATED] By requiring 'spreadsheet/excel' you are loading a Compatibility
-             layer which provides a drop-in replacement for Spreadsheet::Excel
-             versions <= 0.3.5.1. This code will be removed in Spreadsheet
-             version 1.0.0
-EOS
 ##
 # Spreadsheet::Excel Compatibility Layer.
 # Drop-in replacement for Spreadsheet::Excel version <= 0.3.5.1

data/lib/spreadsheet/format.rb

@@ -101,12 +101,12 @@ module Spreadsheet
       @pattern_fg_color = :border
       @pattern_bg_color = :pattern_bg
       @regexes = {
-        :date         => Regexp.new(client("[YMD]", 'UTF-8')),
+        :date         => Regexp.new(client("[YMD]|d{2}|m{3}|y{2}", 'UTF-8')),
         :date_or_time => Regexp.new(client("[hmsYMD]", 'UTF-8')),
         :datetime     => Regexp.new(client("([YMD].*[HS])|([HS].*[YMD])", 'UTF-8')),
         :time         => Regexp.new(client("[hms]", 'UTF-8')),
         :number       => Regexp.new(client("([\#]|0+)", 'UTF-8')),
-        :locale       => Regexp.new(client(/\A\[\$\-\d+\]/.to_s, 'UTF-8')),
+        :locale       => Regexp.new(client(/\A\[\$\-\S+\]/.to_s, 'UTF-8')),
       }
 
       # Temp code to prevent merged formats in non-merged cells.

data/lib/spreadsheet/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Spreadsheet
+  ##
+  # The version of Spreadsheet you are using.
+  VERSION = '1.3.1'
+end

data/lib/spreadsheet/workbook.rb

@@ -76,7 +76,7 @@ module Spreadsheet
     # Returns the count of total worksheets present.
     # Takes no arguments. Just returns the length of @worksheets array.
     def sheet_count
-    @worksheets.length
+      @worksheets.length
     end
     ##
     # The Font at _idx_

data/lib/spreadsheet/worksheet.rb

@@ -49,7 +49,7 @@ module Spreadsheet
         :right => 0.75,
         :bottom => 1
       }
-      @name = opts[:name] || 'Worksheet'
+      @name = sanitize_invalid_characters(opts[:name] || 'Worksheet')
       @workbook = opts[:workbook]
       @rows = []
       @columns = []
@@ -153,9 +153,13 @@ module Spreadsheet
     # If the argument skip is given, #each iterates from that row until but
     # omitting the first unused Row, effectively skipping the first _skip_ Rows
     # from the top of the Worksheet.
-    def each skip=dimensions[0]
-      skip.upto(dimensions[1] - 1) do |idx|
-        yield row(idx)
+    def each(skip=dimensions[0], &block)
+      rows = skip.upto(dimensions[1] - 1).map { |index| row(index) }.to_enum
+
+      if block_given?
+        rows.each(&block)
+      else
+        rows
       end
     end
     def encoding # :nodoc:
@@ -228,6 +232,9 @@ module Spreadsheet
       updated_from idx
       res
     end
+    def << cells=[]
+      insert_row @rows.size, cells
+    end
     def inspect
       names = instance_variables
       names.delete '@rows'
@@ -314,7 +321,7 @@ module Spreadsheet
 
     def compact!
       recalculate_dimensions
-      
+
       # detect first non-nil non-empty row if given first row is empty or nil
       if row(@dimensions[0]).empty? || row(@dimensions[0]).compact.join('').empty?
         (@dimensions[0]...@dimensions[1]).each do |i|
@@ -325,19 +332,19 @@ module Spreadsheet
 
       # detect last non-nil non-empty row if given last row is empty or nil
       if row(@dimensions[1] - 1).empty? || row(@dimensions[1] - 1).compact.join('').empty?
-        i = @dimensions[1] - 1
+        row_size = @dimensions[1] - 1
         @dimensions[1] = @dimensions[0]
         # divide and conquer
-        while(i - @dimensions[1] > 1) do
-          if row(i).empty? || row(i).compact.join('').empty?
-            i = @dimensions[1] + (((i - @dimensions[1]) + 1) / 2).to_i
+        while(row_size - @dimensions[1] > 1) do
+          if row(row_size).empty? || row(row_size).compact.join('').empty?
+            row_size = @dimensions[1] + (((row_size - @dimensions[1]) + 1) / 2).to_i
           else
-            _i = ((i - @dimensions[1]) / 2).to_i + 1
-            @dimensions[1] = i
-            i = i + _i
+            _i = ((row_size - @dimensions[1]) / 2).to_i + 1
+            @dimensions[1] = row_size
+            row_size = row_size + _i
           end
         end
-        @dimensions[1] = i + 1
+        @dimensions[1] = row_size + 1
       end
 
       # detect first non-empty non-nil column if first column is empty or nil
@@ -359,6 +366,9 @@ module Spreadsheet
     end
 
     private
+    def sanitize_invalid_characters(name) # :nodoc:
+      name.gsub(Regexp.new('[\\\/\*\?\:\[\]]'.encode(Spreadsheet.client_encoding)), '_')
+    end
     def index_of_first ary # :nodoc:
       return unless ary
       ary.index(ary.find do |elm| elm end)

data/lib/spreadsheet.rb

@@ -1,3 +1,4 @@
+
 ### Spreadsheet - A Library for reading and writing Spreadsheet Documents.
 #
 #   Copyright (C) 2008-2010 ywesee GmbH
@@ -24,6 +25,7 @@
 #             8006 Zürich
 ###           Switzerland
 
+require 'spreadsheet/version'
 require 'spreadsheet/errors'
 
 require 'spreadsheet/excel/workbook'
@@ -43,10 +45,6 @@ require 'spreadsheet/excel/rgb'
 #  sheet.each do |row| puts row[0] end
 module Spreadsheet
 
-  ##
-  # The version of Spreadsheet you are using.
-  VERSION = '1.1.3'
-
   ##
   # Default client Encoding. Change this value if your application uses a
   # different Encoding:

data/test/excel/reader.rb

@@ -25,6 +25,19 @@ module Spreadsheet
           reader.setup not_empty_io
         end
       end
+
+      def test_not_frozen_stream_error_on_setup
+        return if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3.0')
+
+        reader = Spreadsheet::Excel::Reader.new
+        data = File.expand_path File.join('test', 'data')
+        path = File.join data, 'test_empty.xls'
+        content_string = File.read path
+        frozen_io = StringIO.new(content_string.freeze)
+        assert_nothing_thrown do
+          reader.setup(frozen_io)
+        end
+      end
     end
   end
 end

data/test/format.rb

@@ -25,6 +25,8 @@ module Spreadsheet
       assert_equal false, @format.date?
       @format.number_format = "0.00;[RED]\\-0.00"
       assert_equal false, @format.date?
+      @format.number_format = "[$-C0A]dd\\-mmm\\-yy"
+      assert_equal true, @format.date?
     end
     def test_date_or_time?
       assert_equal false, @format.date_or_time?

data/test/integration.rb

@@ -36,7 +36,7 @@ module Spreadsheet
     end
     def teardown
       Spreadsheet.client_encoding = 'UTF-8'
-      FileUtils.rm_r @var
+      FileUtils.rm_rf @var
     end
     def test_copy__identical__file_paths
       path = File.join @data, 'test_copy.xls'
@@ -70,7 +70,7 @@ module Spreadsheet
     def test_missing_format
       path = File.join @data, 'test_missing_format.xls'
       assert_nothing_thrown do
-        workbook = Spreadsheet.open(path, "rb")
+        Spreadsheet.open(path, "rb")
       end
     end
     def test_version_excel97__excel2010__utf16
@@ -506,7 +506,7 @@ module Spreadsheet
       assert_equal 3, sheets.size
       sheet = book.worksheet 0
       assert_instance_of Excel::Worksheet, sheet
-      str = "S\000h\000e\000e\000t\0001\000"
+      str = "S\000h\000e\000e\000t\0001\000".dup
       if RUBY_VERSION >= '1.9'
         str.force_encoding 'UTF-16LE' if str.respond_to?(:force_encoding)
       end
@@ -730,7 +730,7 @@ module Spreadsheet
       book = Spreadsheet::Excel::Workbook.new
       sheet = book.create_worksheet :name => 'My Worksheet'
       sheet[0,0] = 'my cell'
-      data = StringIO.new ''
+      data = StringIO.new ''.dup
       assert_nothing_raised do
         book.write data
       end
@@ -749,7 +749,7 @@ module Spreadsheet
       sheet1 = book.create_worksheet
       str1 = 'My Shared String'
       str2 = 'Another Shared String'
-      assert_equal 1, (str1.size + str2.size) % 2, 
+      assert_equal 1, (str1.size + str2.size) % 2,
         "str3 should start at an odd offset to test splitting of wide strings"
       str3 = '–––––––––– ' * 1000
       str4 = '1234567890 ' * 1000
@@ -829,7 +829,7 @@ module Spreadsheet
       assert_equal 2, book.worksheets.size
       sheet = book.worksheets.first
       assert_instance_of Spreadsheet::Excel::Worksheet, sheet
-      name = "W\000o\000r\000k\000s\000h\000e\000e\000t\0001\000"
+      name = "W\000o\000r\000k\000s\000h\000e\000e\000t\0001\000".dup
       name.force_encoding 'UTF-16LE' if name.respond_to?(:force_encoding)
       assert_equal name, sheet.name
       assert_not_nil sheet.offset
@@ -926,7 +926,7 @@ module Spreadsheet
       assert_equal 40, sheet1.row(11).height
       assert_instance_of Spreadsheet::Excel::Worksheet, sheet
       sheet = book.worksheets.last
-      name = "m\000y\000 \000n\000a\000m\000e\000"
+      name = "m\000y\000 \000n\000a\000m\000e\000".dup
       name.force_encoding 'UTF-16LE' if name.respond_to?(:force_encoding)
       assert_equal name, sheet.name
       assert_not_nil sheet.offset
@@ -1211,8 +1211,8 @@ module Spreadsheet
       book = Spreadsheet::Workbook.new
       sheet = book.create_worksheet
       (0..200).each { |i| sheet.row(i).push "ëçáéíóú" }
-      assert_nothing_raised do 
-        book.write StringIO.new("", "w+") 
+      assert_nothing_raised do
+        book.write StringIO.new("".dup, "w+")
       end
     end
 
@@ -1257,7 +1257,7 @@ module Spreadsheet
       str1 = "Frozen String.".freeze
       sheet1[0,0] = str1
       sheet1.row(0).push str1
-      assert_nothing_raised do 
+      assert_nothing_raised do
         book.write path
       end
     end
@@ -1290,7 +1290,7 @@ module Spreadsheet
       sheet1 = book.create_worksheet
       (sheet1.row(0).format 0).border = :hair
       (sheet1.row(0).format 0).border_color = :brown
-      assert_nothing_raised do 
+      assert_nothing_raised do
         book.write path
       end
       book2 = Spreadsheet.open path
@@ -1391,7 +1391,7 @@ module Spreadsheet
       path = File.join @var, 'test_write_worksheet_visibility.xls'
       sheet1 = book.create_worksheet
       sheet1.visibility = :hidden
-      sheet2 = book.create_worksheet
+      _sheet2 = book.create_worksheet
       assert_nothing_raised do
         book.write path
       end
@@ -1401,6 +1401,30 @@ module Spreadsheet
       assert_equal(:visible, book2.worksheet(1).visibility)
     end
 
+    def test_append_and_reopen
+      filename = path = File.join @var, 'test.xls'
+      sheet_name = 'Test Sheet'
+
+      # Create excel
+      excel = Spreadsheet::Workbook.new(filename)
+      sheet = excel.create_worksheet(name: sheet_name)
+      sheet.row(1).replace ['Data']
+      excel.write(filename)
+
+      # Append something
+      excel = Spreadsheet.open(filename, 'a+')
+      sheet = excel.worksheet(sheet_name)
+      sheet.row(2).replace ['Data2']
+      filename = "test2.xls"
+      excel.write(filename)
+
+      # Reopen
+      excel = Spreadsheet.open filename
+      sheet = excel.worksheet sheet_name
+    ensure
+      File.delete filename if File.exist? filename
+    end
+
     def test_text_drawing
       path = File.join @data, 'test_text_drawing.xls'
       book = Spreadsheet.open path

data/test/suite.rb

@@ -3,6 +3,8 @@
 require 'rubygems'
 require 'bundler'
 require 'find'
+require 'simplecov'
+SimpleCov.start
 
 $VERBOSE = true
 

data/test/worksheet.rb

@@ -108,18 +108,40 @@ module Spreadsheet
       assert_equal 6, @book.formats.length
 
     end
-    
+
     def test_freeze_panel!
       assert_equal 0, @sheet.froze_top
       assert_equal 0, @sheet.froze_left
       assert_equal false, @sheet.has_frozen_panel?
-      
+
       @sheet.freeze!(2, 3)
       assert_equal 2, @sheet.froze_top
       assert_equal 3, @sheet.froze_left
       assert_equal true, @sheet.has_frozen_panel?
-      
+
+    end
+
+    def test_each_with_skip
+      @sheet[0, 0] = 'foo'
+      @sheet[1, 0] = 'bar'
+
+      assert_equal @sheet.each(1).count, 1
+      assert_equal @sheet.each(1).first[0], 'bar'
     end
-    
+
+    def test_each_with_index
+      @sheet[0, 0] = 'foo'
+      @sheet[1, 0] = 'bar'
+
+      @sheet.each.with_index do |row, index|
+        assert_equal row[0], @sheet[index, 0]
+      end
+    end
+
+    def test_name
+      worksheet = Worksheet.new(name: '\a/b*c?d:e[f]')
+      assert_equal '_a_b_c_d_e_f_', worksheet.name
+    end
+
   end
 end