spreadsheet 1.3.3 → 1.3.5

data/lib/spreadsheet/worksheet.rb

@@ -1,8 +1,8 @@
-require 'date'
-require 'spreadsheet/column'
-require 'spreadsheet/encodings'
-require 'spreadsheet/row'
-require 'spreadsheet/excel/password_hash'
+require "date"
+require "spreadsheet/column"
+require "spreadsheet/encodings"
+require "spreadsheet/row"
+require "spreadsheet/excel/password_hash"
 
 module Spreadsheet
   ##
@@ -28,28 +28,29 @@ module Spreadsheet
     include Spreadsheet::Encodings
     include Spreadsheet::Datatypes
     include Enumerable
+
     attr_accessor :name, :selected, :workbook, :password_hash
     attr_reader :rows, :columns, :merged_cells, :margins, :pagesetup
     attr_reader :froze_top, :froze_left
     enum :visibility, :visible, :hidden, :strong_hidden
-    def initialize opts={}
+    def initialize opts = {}
       @froze_top = 0
       @froze_left = 0
       @default_format = nil
       @selected = opts[:selected]
-      @dimensions = [0,0,0,0]
+      @dimensions = [0, 0, 0, 0]
       @pagesetup = {
-        :orig_data => [9, 100, 1, 1, 1, 0, 300, 300, 0.5, 0.5, 1],
-        :orientation => :portrait,
-        :adjust_to => 100
+        orig_data: [9, 100, 1, 1, 1, 0, 300, 300, 0.5, 0.5, 1],
+        orientation: :portrait,
+        adjust_to: 100
       }
       @margins = {
-        :top => 1,
-        :left => 0.75,
-        :right => 0.75,
-        :bottom => 1
+        top: 1,
+        left: 0.75,
+        right: 0.75,
+        bottom: 1
       }
-      @name = sanitize_invalid_characters(opts[:name] || 'Worksheet')
+      @name = sanitize_invalid_characters(opts[:name] || "Worksheet")
       @workbook = opts[:workbook]
       @rows = []
       @columns = []
@@ -59,6 +60,7 @@ module Spreadsheet
       @password_hash = 0
       @visibility = opts[:visibility]
     end
+
     def has_frozen_panel?
       @froze_top > 0 or @froze_left > 0
     end
@@ -67,39 +69,47 @@ module Spreadsheet
       @froze_top = top.to_i
       @froze_left = left.to_i
     end
+
     def active # :nodoc:
       warn "Worksheet#active is deprecated. Please use Worksheet#selected instead."
       selected
     end
+
     def active= selected # :nodoc:
       warn "Worksheet#active= is deprecated. Please use Worksheet#selected= instead."
       self.selected = selected
     end
+
     ##
     # Add a Format to the Workbook. If you use Row#set_format, you should not
     # need to use this Method.
     def add_format fmt
       @workbook.add_format fmt if fmt
     end
+
     ##
     # Get the enriched value of the Cell at _row_, _column_.
     # See also Worksheet#[], Row#[].
     def cell row, column
       row(row)[column]
     end
+
     ##
     # Returns the Column at _idx_.
     def column idx
-      @columns[idx] || Column.new(idx, default_format, :worksheet => self)
+      @columns[idx] || Column.new(idx, default_format, worksheet: self)
     end
+
     ##
     # The number of columns in this Worksheet which contain data.
     def column_count
       dimensions[3] - dimensions[2]
     end
+
     def column_updated idx, column
       @columns[idx] = column
     end
+
     ##
     # Delete the Row at _idx_ (0-based) from this Worksheet.
     def delete_row idx
@@ -107,33 +117,36 @@ module Spreadsheet
       updated_from idx
       res
     end
+
     ##
     # The default Format of this Worksheet, if you have set one.
     # Returns the Workbook's default Format otherwise.
     def default_format
       @default_format || @workbook.default_format
     end
+
     ##
     # Set the default Format of this Worksheet.
     def default_format= format
       @default_format = format
       add_format format
-      format
     end
+
     ##
     # Is the worksheet protected?
     def protected?
       @protected
     end
+
     ##
     # Set worklist protection
-    def protect! password = ''
+    def protect! password = ""
       @protected = true
       password = password.to_s
-      if password.size == 0
-        @password_hash = 0
+      @password_hash = if password.size == 0
+        0
       else
-        @password_hash = Excel::Password.password_hash password
+        Excel::Password.password_hash password
       end
     end
 
@@ -146,6 +159,7 @@ module Spreadsheet
     def dimensions
       @dimensions || recalculate_dimensions
     end
+
     ##
     # If no argument is given, #each iterates over all used Rows (from the first
     # used Row until but omitting the first unused Row, see also #dimensions).
@@ -153,7 +167,7 @@ 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], &block)
+    def each(skip = dimensions[0], &block)
       rows = skip.upto(dimensions[1] - 1).map { |index| row(index) }.to_enum
 
       if block_given?
@@ -162,9 +176,11 @@ module Spreadsheet
         rows
       end
     end
+
     def encoding # :nodoc:
       @workbook.encoding
     end
+
     ##
     # Sets the default Format of the column at _idx_.
     #
@@ -175,39 +191,40 @@ module Spreadsheet
     #
     # Returns an instance of Column if _idx_ is an Integer, an Array of Columns
     # otherwise.
-    def format_column idx, format=nil, opts={}
+    def format_column idx, format = nil, opts = {}
       opts[:worksheet] = self
       res = case idx
-            when Integer
-              column = nil
-              if format
-                column = Column.new(idx, format, opts)
-              end
-              @columns[idx] = column
-            else
-              idx.collect do |col| format_column col, format, opts end
-            end
+      when Integer
+        column = nil
+        if format
+          column = Column.new(idx, format, opts)
+        end
+        @columns[idx] = column
+      else
+        idx.collect { |col| format_column col, format, opts }
+      end
       shorten @columns
       res
     end
+
     ##
     # Formats all Date, DateTime and Time cells with _format_ or the default
     # formats:
     # - 'DD.MM.YYYY' for Date
     # - 'DD.MM.YYYY hh:mm:ss' for DateTime and Time
-    def format_dates! format=nil
+    def format_dates! format = nil
       new_formats = {}
-      fmt_str_time = client('DD.MM.YYYY hh:mm:ss', 'UTF-8')
-      fmt_str_date = client('DD.MM.YYYY', 'UTF-8')
+      fmt_str_time = client("DD.MM.YYYY hh:mm:ss", "UTF-8")
+      fmt_str_date = client("DD.MM.YYYY", "UTF-8")
       each do |row|
         row.each_with_index do |value, idx|
           unless row.formats[idx] || row.format(idx).date_or_time?
             numfmt = case value
-                     when DateTime, Time
-                       format || fmt_str_time
-                     when Date
-                       format || fmt_str_date
-                     end
+            when DateTime, Time
+              format || fmt_str_time
+            when Date
+              format || fmt_str_date
+            end
             case numfmt
             when Format
               row.set_format idx, numfmt
@@ -225,52 +242,61 @@ module Spreadsheet
         end
       end
     end
+
     ##
     # Insert a Row at _idx_ (0-based) containing _cells_
-    def insert_row idx, cells=[]
+    def insert_row idx, cells = []
       res = @rows.insert idx, Row.new(self, idx, cells)
       updated_from idx
       res
     end
-    def << cells=[]
+
+    def << cells = []
       insert_row @rows.size, cells
     end
+
     def inspect
       names = instance_variables
-      names.delete '@rows'
+      names.delete "@rows"
       variables = names.collect do |name|
         "%s=%s" % [name, instance_variable_get(name)]
-      end.join(' ')
+      end.join(" ")
       sprintf "#<%s:0x%014x %s @rows[%i]>", self.class, object_id,
-                                            variables, row_count
+        variables, row_count
     end
+
     ## The last Row containing any data
     def last_row
       row(last_row_index)
     end
+
     ## The index of the last Row containing any data
     def last_row_index
       [dimensions[1] - 1, 0].max
     end
+
     ##
     # Replace the Row at _idx_ with the following arguments. Like #update_row,
     # but truncates the Row if there are fewer arguments than Cells in the Row.
     def replace_row idx, *cells
-      if(row = @rows[idx]) && cells.size < row.size
+      if (row = @rows[idx]) && cells.size < row.size
         cells.concat Array.new(row.size - cells.size)
       end
       update_row idx, *cells
     end
+
     ##
     # The Row at _idx_ or a new Row.
     def row idx
       @rows[idx] || Row.new(self, idx)
     end
+
     ##
     # The number of Rows in this Worksheet which contain data.
     def row_count
       dimensions[1] - dimensions[0]
     end
+
     ##
     # Tell Worksheet that the Row at _idx_ has been updated and the #dimensions
     # need to be recalculated. You should not need to call this directly.
@@ -278,18 +304,20 @@ module Spreadsheet
       @dimensions = nil
       @rows[idx] = row
     end
+
     ##
     # Updates the Row at _idx_ with the following arguments.
     def update_row idx, *cells
-      res = if row = @rows[idx]
-              row[0, cells.size] = cells
-              row
-            else
-              Row.new self, idx, cells
-            end
+      res = if (row = @rows[idx])
+        row[0, cells.size] = cells
+        row
+      else
+        Row.new self, idx, cells
+      end
       row_updated idx, res
       res
     end
+
     ##
     # Renumbers all Rows starting at _idx_ and calls #row_updated for each of
     # them.
@@ -300,18 +328,21 @@ module Spreadsheet
         row_updated idx, row
       end
     end
+
     ##
     # Get the enriched value of the Cell at _row_, _column_.
     # See also Worksheet#cell, Row#[].
     def [] row, column
       row(row)[column]
     end
+
     ##
     # Set the value of the Cell at _row_, _column_ to _value_.
     # See also Row#[]=.
     def []= row, column, value
       row(row)[column] = value
     end
+
     ##
     # Merges multiple cells into one.
     def merge_cells start_row, start_col, end_row, end_col
@@ -323,66 +354,70 @@ module Spreadsheet
       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?
+      if row(@dimensions[0]).empty? || row(@dimensions[0]).compact.join("").empty?
         (@dimensions[0]...@dimensions[1]).each do |i|
-          break unless row(i).empty? || row(i).compact.join('').empty?
+          break unless row(i).empty? || row(i).compact.join("").empty?
           @dimensions[0] = i
         end
       end
 
       # 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?
+      if row(@dimensions[1] - 1).empty? || row(@dimensions[1] - 1).compact.join("").empty?
         row_size = @dimensions[1] - 1
         @dimensions[1] = @dimensions[0]
         # divide and conquer
-        while(row_size - @dimensions[1] > 1) do
-          if row(row_size).empty? || row(row_size).compact.join('').empty?
+        while row_size - @dimensions[1] > 1
+          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 = ((row_size - @dimensions[1]) / 2).to_i + 1
+            idx = ((row_size - @dimensions[1]) / 2).to_i + 1
             @dimensions[1] = row_size
-            row_size = row_size + _i
+            row_size += idx
           end
         end
         @dimensions[1] = row_size + 1
       end
 
       # detect first non-empty non-nil column if first column is empty or nil
-      if (@dimensions[0]..@dimensions[1]).inject(true){|t, j| t && row(j)[@dimensions[2]].nil?}
+      if (@dimensions[0]..@dimensions[1]).inject(true) { |t, j| t && row(j)[@dimensions[2]].nil? }
         (@dimensions[2]..@dimensions[3]).each do |i|
-          break unless (@dimensions[0]..@dimensions[1]).inject(true){|t, j| t && row(j)[i].to_s.empty?}
+          break unless (@dimensions[0]..@dimensions[1]).inject(true) { |t, j| t && row(j)[i].to_s.empty? }
           @dimensions[2] = i
         end
       end
 
       # detect last non-empty non-nil column if last column is empty or nil
-      if (@dimensions[0]..@dimensions[1]).inject(true){|t, j| t && row(j)[@dimensions[3]].nil?}
+      if (@dimensions[0]..@dimensions[1]).inject(true) { |t, j| t && row(j)[@dimensions[3]].nil? }
         (@dimensions[2]..@dimensions[3]).reverse_each do |i|
-          break unless (@dimensions[0]..@dimensions[1]).inject(true){|t, j| t && row(j)[i].to_s.empty?}
+          break unless (@dimensions[0]..@dimensions[1]).inject(true) { |t, j| t && row(j)[i].to_s.empty? }
           @dimensions[3] = i
         end
-        @dimensions[3] = @dimensions[3]
+        @dimensions[3]
       end
     end
 
     private
+
     def sanitize_invalid_characters(name) # :nodoc:
-      name.gsub(Regexp.new('[\\\/\*\?\:\[\]]'.encode(Spreadsheet.client_encoding)), '_')
+      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)
+      ary.index(ary.find { |elm| elm })
     end
+
     def recalculate_dimensions # :nodoc:
       shorten @rows
       @dimensions = []
       @dimensions[0] = index_of_first(@rows) || 0
       @dimensions[1] = @rows.size
       compact = @rows.compact
-      @dimensions[2] = compact.collect do |row| row.first_used end.compact.min || 0
-      @dimensions[3] = compact.collect do |row| row.first_unused end.max || 0
+      @dimensions[2] = compact.collect { |row| row.first_used }.compact.min || 0
+      @dimensions[3] = compact.collect { |row| row.first_unused }.max || 0
       @dimensions
     end
+
     def shorten ary # :nodoc:
       return unless ary
       while !ary.empty? && !ary.last

data/lib/spreadsheet/writer.rb

@@ -6,6 +6,7 @@ module Spreadsheet
     def initialize io_or_path
       @io_or_path = io_or_path
     end
+
     def write workbook
       if @io_or_path.respond_to? :seek
         @io_or_path.binmode
@@ -16,7 +17,9 @@ module Spreadsheet
         end
       end
     end
+
     private
+
     def write_workbook workbook, io
       reader = workbook.io
       unless io == reader

data/lib/spreadsheet.rb

@@ -1,4 +1,3 @@
-
 ### Spreadsheet - A Library for reading and writing Spreadsheet Documents.
 #
 #   Copyright (C) 2008-2010 ywesee GmbH
@@ -25,12 +24,12 @@
 #             8006 Zürich
 ###           Switzerland
 
-require 'spreadsheet/version'
-require 'spreadsheet/errors'
+require "spreadsheet/version"
+require "spreadsheet/errors"
 
-require 'spreadsheet/excel/workbook'
-require 'spreadsheet/excel/reader'
-require 'spreadsheet/excel/rgb'
+require "spreadsheet/excel/workbook"
+require "spreadsheet/excel/reader"
+require "spreadsheet/excel/rgb"
 
 # = Synopsis
 # The Spreadsheet Library is designed to read and write Spreadsheet Documents.
@@ -44,38 +43,36 @@ require 'spreadsheet/excel/rgb'
 #  sheet = book.worksheet 0
 #  sheet.each do |row| puts row[0] end
 module Spreadsheet
-
   ##
   # Default client Encoding. Change this value if your application uses a
   # different Encoding:
   # Spreadsheet.client_encoding = 'ISO-LATIN-1//TRANSLIT//IGNORE'
-  @client_encoding = 'UTF-8'
-  @enc_translit = 'TRANSLIT'
-  @enc_ignore = 'IGNORE'
+  @client_encoding = "UTF-8"
+  @enc_translit = "TRANSLIT"
+  @enc_ignore = "IGNORE"
 
   class << self
-
     attr_accessor :client_encoding, :enc_translit, :enc_ignore
 
     ##
     # Parses a Spreadsheet Document and returns a Workbook object. At present,
     # only Excel-Documents can be read.
-    def open io_or_path, mode="rb+"
+    def open io_or_path, mode = "rb+"
       if io_or_path.respond_to? :seek
         Excel::Workbook.open(io_or_path)
       elsif block_given?
         File.open(io_or_path, mode) do |fh|
-          yield open(fh)
+          yield open(fh) # standard:disable Security/Open
         end
       else
-        open File.open(io_or_path, mode)
+        open File.open(io_or_path, mode) # standard:disable Security/Open
       end
     end
 
     ##
     # Returns a Writer object for the specified path. At present, only the
     # Excel-Writer is available.
-    def writer io_or_path, type=Excel
+    def writer io_or_path, type = Excel
       Excel::Writer::Workbook.new io_or_path
     end
   end

data/test/excel/reader.rb

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 # Excel::TestReader -- Spreadsheet -- 22.01.2013
 
-$: << File.expand_path('../../../lib', File.dirname(__FILE__))
+$: << File.expand_path("../../../lib", File.dirname(__FILE__))
 
-require 'test/unit'
+require "test/unit"
 
 module Spreadsheet
   module Excel
@@ -18,8 +18,8 @@ module Spreadsheet
 
       def test_not_empty_file_error_on_setup
         reader = Spreadsheet::Excel::Reader.new
-        data = File.expand_path File.join('test', 'data')
-        path = File.join data, 'test_empty.xls'
+        data = File.expand_path File.join("test", "data")
+        path = File.join data, "test_empty.xls"
         not_empty_io = File.open(path, "rb")
         assert_nothing_thrown do
           reader.setup not_empty_io
@@ -27,11 +27,11 @@ module Spreadsheet
       end
 
       def test_not_frozen_stream_error_on_setup
-        return if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3.0')
+        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'
+        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
@@ -40,4 +40,4 @@ module Spreadsheet
       end
     end
   end
-end
+end

data/test/excel/row.rb

@@ -1,40 +1,44 @@
 #!/usr/bin/env ruby
 # Excel::TestRow -- Spreadsheet -- 12.10.2008 -- hwyss@ywesee.com
 
-$: << File.expand_path('../../lib', File.dirname(__FILE__))
+$: << File.expand_path("../../lib", File.dirname(__FILE__))
 
-require 'test/unit'
-require 'spreadsheet'
+require "test/unit"
+require "spreadsheet"
 
 module Spreadsheet
   module Excel
-class TestRow < Test::Unit::TestCase
-  def setup
-    @workbook = Excel::Workbook.new
-    @worksheet = Excel::Worksheet.new
-    @workbook.add_worksheet @worksheet
-  end
-  def test_date
-    row = Row.new @worksheet, 0, [nil, 27627.6789]
-    assert_equal Date.new(1975,8,21), row.date(1)
-  end
-  def test_to_a
-    row = Row.new @worksheet, 0, [nil, 1, 27627.6789]
-    row.set_format(2, Format.new(:number_format => 'DD.MM.YYYY'))
-    assert_equal [nil, 1, Date.new(1975, 8, 21)], row.to_a
-  end
-  def test_datetime
-    row = Row.new @worksheet, 0, [nil, 27627.765]
-    d1 = DateTime.new(1975,8,21) + 0.765
-    d2 = row.datetime 1
-    assert_equal d1, d2
-  end
-  def test_datetime_overflow
-    row = Row.new @worksheet, 0, [nil, 40010.6666666666]
-    d1 = DateTime.new(2009,07,16,16)
-    d2 = row.datetime 1
-    assert_equal d1, d2
-  end
-end
+    class TestRow < Test::Unit::TestCase
+      def setup
+        @workbook = Excel::Workbook.new
+        @worksheet = Excel::Worksheet.new
+        @workbook.add_worksheet @worksheet
+      end
+
+      def test_date
+        row = Row.new @worksheet, 0, [nil, 27627.6789]
+        assert_equal Date.new(1975, 8, 21), row.date(1)
+      end
+
+      def test_to_a
+        row = Row.new @worksheet, 0, [nil, 1, 27627.6789]
+        row.set_format(2, Format.new(number_format: "DD.MM.YYYY"))
+        assert_equal [nil, 1, Date.new(1975, 8, 21)], row.to_a
+      end
+
+      def test_datetime
+        row = Row.new @worksheet, 0, [nil, 27627.765]
+        d1 = DateTime.new(1975, 8, 21) + 0.765
+        d2 = row.datetime 1
+        assert_equal d1, d2
+      end
+
+      def test_datetime_overflow
+        row = Row.new @worksheet, 0, [nil, 40010.6666666666]
+        d1 = DateTime.new(2009, 0o7, 16, 16)
+        d2 = row.datetime 1
+        assert_equal d1, d2
+      end
+    end
   end
 end