spreadsheet 1.2.6 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c8aa45d407cf5aeadbf8af753a674fdf12dab84c
-  data.tar.gz: 32a18ad8a2d79f9eb5df62f435560502c05bfbb8
+SHA256:
+  metadata.gz: a831e5c252775858cbdba547a3ac3228028cb6c9a56a92a77ab8fdc393de0658
+  data.tar.gz: 1240cd6a3b8362fa9c807c26d36fd6f8df19872e195ce09e98583597f73fa8cc
 SHA512:
-  metadata.gz: 97f97bf780ece2ac6f25906106b1f62c1cb681cb91740620321875de8fcd2489dc97c592a4d143c52f1cd78c6f737e2b12a33fe3d6a0715ecd4f390461ffa713
-  data.tar.gz: ddb5ee3babe8492581be775a760db74dd4f392f75773386c6a204682e051f20b56d004091741653691eba09f7e8433588945b266784747d95b5cfae4f0836180
+  metadata.gz: 35dd4c09f32c793bf85f4290a497eb25a298b2f59e107eb4ecebf3c37e1e6a1ee505eaec3409057c0914754ca9036fb8a4c173c8d251e448ef932e38489d0c04
+  data.tar.gz: b20106050e1370ced689559af16e97efc4b19abde21165091d9f4a1ebea02758625713f09e20be0ccf7b8be2075fc59567c5bf581e583a2250ccc81ee04b2e5f

data/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/bundler

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("bundler", "bundler")

data/bin/oletool

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'oletool' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("ruby-ole", "oletool")

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/sow

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'sow' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("hoe", "sow")

data/bin/xlsopcodes

@@ -1,18 +1,29 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'spreadsheet'
+#
+# This file was generated by Bundler.
+#
+# The application 'xlsopcodes' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
 
-source, target = ARGV
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
 
-if source.nil?
-  puts "Usage: #{$0} <source> [<target>]"
-  exit -1
-end
+bundle_binstub = File.expand_path("../bundle", __FILE__)
 
-target = target ? File.open(target, 'w') : STDOUT
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
 
-reader = Spreadsheet::Excel::Reader.new :print_opcodes => target
-reader.setup File.open(source)
+require "rubygems"
+require "bundler/setup"
 
-while tuple = reader.get_next_chunk
-end
+load Gem.bin_path("spreadsheet", "xlsopcodes")

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

@@ -241,81 +241,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, len)|
-      [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_colinfos
-    write_guts
-
-    @io.write reader.read(endpos - lastpos)
-  end
   def write_colinfo bunch
     col = bunch.first
     width = col.width.to_f * 256

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

@@ -164,93 +164,6 @@ class Workbook < Spreadsheet::Writer
     end
   end
   ##
-  # Copy unchanged data verbatim, adjust offsets and write new records for
-  # changed data.
-  def write_changes workbook, io
-    sanitize_worksheets workbook.worksheets
-    collect_formats workbook, :existing_document => true
-    reader = workbook.ole
-    sheet_data = {}
-    sst_status, sst_total, sst_strings = complete_sst_update? workbook
-    sst = {}
-    sst_strings.each_with_index do |str, idx| sst.store str, idx end
-    sheets = worksheets(workbook)
-    positions = []
-    newsheets = []
-    sheets.each do |sheet|
-      @sst[sheet] = sst
-      pos, len = workbook.offsets[sheet.worksheet]
-      if pos
-        positions.push pos
-        sheet.write_changes reader, pos + len, sst_status
-      else
-        newsheets.push sheet
-        sheet.write_from_scratch
-      end
-      sheet_data[sheet.worksheet] = sheet.data
-    end
-    Ole::Storage.open io do |ole|
-      ole.file.open 'Workbook', 'w' do |writer|
-        reader.seek lastpos = 0
-        workbook.offsets.select do |key, pair|
-          workbook.changes.include? key
-        end.sort_by do |key, (pos, _)|
-          pos
-        end.each do |key, (pos, len)|
-          data = reader.read(pos - lastpos)
-          writer.write data
-          case key
-          when Spreadsheet::Worksheet
-            writer.write sheet_data[key]
-          when :boundsheets
-            ## boundsheets are hard to calculate. The offset below is only
-            #  correct if there are no more changes in the workbook globals
-            #  string after this.
-            oldoffset = positions.min - len
-            lastpos = pos + len
-            bytechange = 0
-            buffer = StringIO.new ''.dup
-            if tuple = workbook.offsets[:sst]
-              write_sst_changes workbook, buffer, writer.pos,
-                                sst_total, sst_strings
-              pos, len = tuple
-              if offset = workbook.offsets[:extsst]
-                len += offset[1].to_i
-              end
-              bytechange = buffer.size - len
-              write_boundsheets workbook, writer, oldoffset + bytechange
-              reader.seek lastpos
-              writer.write reader.read(pos - lastpos)
-              buffer.rewind
-              writer.write buffer.read
-            elsif sst.empty? || workbook.biff_version < 8
-              write_boundsheets workbook, writer, oldoffset + bytechange
-            else
-              write_sst workbook, buffer, writer.pos
-              write_boundsheets workbook, writer, oldoffset + buffer.size
-              pos = lastpos
-              len = positions.min - lastpos
-              if len > OPCODE_SIZE
-                reader.seek pos
-                writer.write reader.read(len - OPCODE_SIZE)
-              end
-              buffer.rewind
-              writer.write buffer.read
-              write_eof workbook, writer
-            end
-          else
-            send "write_#{key}", workbook, writer
-          end
-          lastpos = [pos + len, reader.size - 1].min
-          reader.seek lastpos
-        end
-        writer.write reader.read
-        newsheets.each do |sheet|
-          writer.write sheet.data
-        end
-      end
-    end
-  end
   def write_datemode workbook, writer
     mode = @date_base.year == 1899 ? 0x00 : 0x01
     data = [
@@ -639,8 +552,7 @@ class Workbook < Spreadsheet::Writer
     write_op writer, 0x003d, data.pack('v*')
   end
   ##
-  # The main writer method. Calls #write_from_scratch or #write_changes
-  # depending on the class and state of _workbook_.
+  # The main writer method. Calls #write_from_scratch.
   def write_workbook workbook, io
     unless workbook.is_a?(Excel::Workbook) && workbook.io
       @date_base = Date.new 1899, 12, 31
@@ -650,7 +562,8 @@ class Workbook < Spreadsheet::Writer
       if workbook.changes.empty?
         super
       else
-        write_changes workbook, io
+        @date_base = Date.new 1899, 12, 31
+        write_from_scratch workbook, io
       end
     end
   ensure

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

@@ -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

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/version.rb

@@ -3,5 +3,5 @@
 module Spreadsheet
   ##
   # The version of Spreadsheet you are using.
-  VERSION = '1.2.6'
+  VERSION = '1.3.0'
 end

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 = []
@@ -233,7 +233,7 @@ module Spreadsheet
       res
     end
     def << cells=[]
-      insert_row last_row_index + 1, cells
+      insert_row @rows.size, cells
     end
     def inspect
       names = instance_variables
@@ -366,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/test/integration.rb

@@ -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

@@ -138,5 +138,10 @@ module Spreadsheet
       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