rubyXL 3.2.7 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78d8560310cff3db8a14ada15250fd8ccc4a0cf4
-  data.tar.gz: 934202bae68313dbc61ee8e35b1b70d3e36b856e
+  metadata.gz: 4de40cef47a71af3b19e027b2508941f63d82f1d
+  data.tar.gz: 0b2696764fdf2513922baafc8c84c4c224641156
 SHA512:
-  metadata.gz: 8abe16d619a9ef123a2b621fcf4bb17f8e7266fbceb1919a3b9d1ad6ab3ce21a597d15900834883e12ecba77a271fc2071ddf3b05dfbe28de7164324aaea06b9
-  data.tar.gz: 9580942eb45bca0b491622c16bd82e528444340c22e90345b772f6b3903ab2a3fae815cc5e0d1c3c6b78f98039c2c41b05570afe643bcaf442ff3b59acf1fb02
+  metadata.gz: 9893bbaebe5a580c6d9fb78c9949e7baf407640eea6e127435c502c301442abb4256165e8a7aa7031033ab68ddfbd03fdad7c7d5ae9e6ae4f65a09623d69e221
+  data.tar.gz: 0c41ea643f4a75692f66e7eeb2d6bdc260d42c86263e021be1aeb197fc5ab477a16c937e590a3236ba2b2422b1cbf26e2238060aed17d3286fac6cd04ee385f4

data/Gemfile

@@ -11,4 +11,6 @@ group :development do
   gem "jeweler"
   gem "simplecov", ">= 0"
   gem "rspec", ">= 1.3.4"
+
+  gem 'stackprof'
 end

data/Rakefile

@@ -1,7 +1,7 @@
 # encoding: utf-8
-
 require 'rubygems'
 require 'bundler'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -44,7 +44,6 @@ end
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
-
 task :default => :spec
 
 require 'rdoc/task'
@@ -56,3 +55,30 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+desc "Dump profiling data"
+task :profile do
+  require 'benchmark'
+  require 'stackprof'
+
+  $:.unshift File.dirname(__FILE__) + '/lib'  # Make Ruby aware of load path
+  require './lib/rubyXL'
+
+  spreadsheets = Dir.glob(File.join("test", "input", "*.xls?")).sort!
+
+  spreadsheets.each { |input|
+    puts "<<<--- Profiling parsing #{input}..."
+    doc = nil
+    StackProf.run(:mode => :cpu, :interval => 100, 
+                  :out  => "tmp/stackprof-cpu-parse-#{File.basename(input)}.dump") { 
+      doc = RubyXL::Parser.parse(input)
+    }
+
+    output = File.join("test", "output", File.basename(input))
+    puts  "--->>> Profiling writing of #{output}..."
+    StackProf.run(:mode => :cpu, :interval => 100, 
+                  :out  => "tmp/stackprof-cpu-write-#{File.basename(input)}.dump") {
+      doc.write(output)
+    }
+  }
+end

data/VERSION

@@ -1 +1 @@
-3.2.7
+3.3.0

data/lib/rubyXL/cell.rb

@@ -204,11 +204,6 @@ module RubyXL
 
     private
 
-    def get_border(direction)
-      validate_worksheet
-      get_cell_border.get_edge_style(direction)
-    end
-
     def validate_workbook()
       unless workbook.nil? || workbook.worksheets.nil?
         workbook.worksheets.each { |sheet|

data/lib/rubyXL/convenience_methods.rb

@@ -221,11 +221,18 @@ module RubyXL
     def get_row_height(row = 0)
       validate_workbook
       validate_nonnegative(row)
-      return nil unless row_exists(row)
       row = sheet_data.rows[row]
       row && row.ht || 13
     end
 
+    def get_row_border(row, border_direction)
+      validate_workbook
+      validate_nonnegative(row)
+
+      border = @workbook.borders[get_row_xf(row).border_id]
+      border && border.get_edge_style(border_direction)
+    end
+
     def get_row_horizontal_alignment(row = 0)
       return get_row_alignment(row, true)
     end
@@ -314,11 +321,27 @@ module RubyXL
     def get_column_fill(col=0)
       validate_workbook
       validate_nonnegative(col)
-      return nil unless column_exists(col)
 
       @workbook.get_fill_color(get_col_xf(col))
     end
 
+    def get_column_border(col, border_direction)
+      validate_workbook
+      validate_nonnegative(col)
+
+      xf = @workbook.cell_xfs[get_cols_style_index(col)]
+      border = @workbook.borders[xf.border_id]
+      border && border.get_edge_style(border_direction)
+    end
+
+    def get_column_alignment(col, type)
+      validate_workbook
+      validate_nonnegative(col)
+
+      xf = @workbook.cell_xfs[get_cols_style_index(col)]
+      xf.alignment && xf.alignment.send(type)
+    end
+
     def get_column_horizontal_alignment(col=0)
       warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_column_alignment` instead."
       get_column_alignment(col, :horizontal)
@@ -599,6 +622,11 @@ module RubyXL
 
   module CellConvenienceMethods
 
+    def get_border(direction)
+      validate_worksheet
+      get_cell_border.get_edge_style(direction)
+    end
+
     def change_horizontal_alignment(alignment = 'center')
       validate_worksheet
       self.style_index = workbook.modify_alignment(self.style_index) { |a| a.horizontal = alignment }
@@ -619,56 +647,6 @@ module RubyXL
       self.style_index = workbook.modify_border(self.style_index, direction, weight)
     end
 
-    def change_border_top(weight = 'thin')
-      warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_border` instead."
-      change_border(:top, weight)
-    end
-
-    def change_border_left(weight = 'thin')
-      warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_border` instead."
-      change_border(:left, weight)
-    end
-
-    def change_border_right(weight = 'thin')
-      warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_border` instead."
-      change_border(:right, weight)
-    end
-
-    def change_border_bottom(weight = 'thin')
-      warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_border` instead."
-      change_border(:bottom, weight)
-    end
-
-    def change_border_diagonal(weight = 'thin')
-      warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_border` instead."
-      change_border(:diagonal, weight)
-    end
-
-    def border_top()
-      warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_border` instead."
-      return get_border(:top)
-    end
-
-    def border_left()
-      warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_border` instead."
-      return get_border(:left)
-    end
-
-    def border_right()
-      warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_border` instead."
-      return get_border(:right)
-    end
-
-    def border_bottom()
-      warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_border` instead."
-      return get_border(:bottom)
-    end
-
-    def border_diagonal()
-      warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `get_border` instead."
-      return get_border(:diagonal)
-    end
-
   end
 
 end

data/lib/rubyXL/objects/ooxml_object.rb

@@ -1,3 +1,4 @@
+require 'nokogiri'
 require 'pathname'
 require 'rubyXL/objects/reference'
 
@@ -381,6 +382,7 @@ module RubyXL
       "<#{self.class}: #{super} #{vars.join(", ")}>"
     end
 
+
     class << self
       def define_count_attribute
         # Count will be inherited from Array. so no need to define it explicitly.

data/lib/rubyXL/objects/root.rb

@@ -59,14 +59,28 @@ module RubyXL
       OOXMLTopLevelObject::ROOT
     end
 
-    def self.parse_file(xl_file_path, opts)
+    def self.parse_file(xl_file_path, opts = {})
       begin
         ::Zip::File.open(xl_file_path) { |zip_file|
           root = self.new
           root.filepath = xl_file_path
           root.content_types = RubyXL::ContentTypes.parse_file(zip_file, ContentTypes::XLSX_PATH)
           root.load_relationships(zip_file, OOXMLTopLevelObject::ROOT)
-          root.workbook.root = root
+
+          wb = root.workbook
+          wb.root = root
+
+          wb.sheets.each_with_index { |sheet, i|
+            sheet_obj = wb.relationship_container.related_files[sheet.r_id]
+
+            wb.worksheets[i] = sheet_obj # Must be done first so the sheet becomes aware of its number
+            sheet_obj.workbook = wb
+
+            sheet_obj.sheet_name = sheet.name
+            sheet_obj.sheet_id = sheet.sheet_id
+            sheet_obj.state = sheet.state
+          }
+
           root
         }
       rescue ::Zip::Error => e

data/lib/rubyXL/parser.rb

@@ -1,37 +1,8 @@
-require 'nokogiri'
-require 'tmpdir'
-
 module RubyXL
-
   class Parser
-    def self.parse(file_path, opts = {})
-      self.new(opts).parse(file_path)
+    def self.parse(xl_file_path)
+      root = RubyXL::WorkbookRoot.parse_file(xl_file_path)
+      root.workbook
     end
-
-    # +:data_only+ allows only the sheet data to be parsed, so as to speed up parsing.
-    # However, using this option will result in date-formatted cells being interpreted as numbers.
-    def initialize(opts = {})
-      @opts = opts
-    end
-
-    def parse(xl_file_path)
-      root = RubyXL::WorkbookRoot.parse_file(xl_file_path, @opts)
-
-      wb = root.workbook
-
-      wb.sheets.each_with_index { |sheet, i|
-        sheet_obj = wb.relationship_container.related_files[sheet.r_id]
-
-        wb.worksheets[i] = sheet_obj # Must be done first so the sheet becomes aware of its number
-        sheet_obj.workbook = wb
-
-        sheet_obj.sheet_name = sheet.name
-        sheet_obj.sheet_id = sheet.sheet_id
-        sheet_obj.state = sheet.state
-      }
-
-      wb
-    end
-
   end
 end

data/lib/rubyXL/worksheet.rb

@@ -135,38 +135,40 @@ module LegacyWorksheet
     merged_cells << RubyXL::MergedCell.new(:ref => RubyXL::Reference.new(row1, row2, col1, col2))
   end
 
-  def add_row(row = 0, params = {})
+  def add_row(row_index = 0, params = {})
     new_row = RubyXL::Row.new(params)
     new_row.worksheet = self
-    sheet_data.rows[row] = new_row
+    sheet_data.rows[row_index] = new_row
   end
 
-  def add_cell(row = 0, column = 0, data = '', formula = nil, overwrite = true)
+  def add_cell(row_index = 0, column_index = 0, data = '', formula = nil, overwrite = true)
     validate_workbook
-    ensure_cell_exists(row, column)
+    validate_nonnegative(row_index)
+    validate_nonnegative(column_index)
+    row = sheet_data.rows[row_index] || add_row(row_index)
+
+    c = row.cells[column_index]
 
-    if overwrite || sheet_data.rows[row].cells[column].nil?
+    if overwrite || c.nil?
       c = RubyXL::Cell.new
       c.worksheet = self
-      c.row = row
-      c.column = column
+      c.row = row_index
+      c.column = column_index
       c.raw_value = data
       c.datatype = RubyXL::DataType::RAW_STRING unless formula || data.is_a?(Numeric)
       c.formula = RubyXL::Formula.new(:expression => formula) if formula
 
-      range = cols && cols.locate_range(column)
-      c.style_index = sheet_data.rows[row].style_index || (range && range.style_index) || 0
-
-      sheet_data.rows[row].cells[column] = c
+      range = cols && cols.locate_range(column_index)
+      c.style_index = row.style_index || (range && range.style_index) || 0
+      row.cells[column_index] = c
     end
 
-    sheet_data.rows[row].cells[column]
+    c
   end
 
   def delete_row(row_index=0)
     validate_workbook
     validate_nonnegative(row_index)
-    return nil unless row_exists(row_index)
 
     deleted = sheet_data.rows.delete_at(row_index)
 
@@ -216,8 +218,7 @@ module LegacyWorksheet
     validate_workbook
     validate_nonnegative(column_index)
 
-    return nil unless column_exists(column_index)
-
+    #delete column
     sheet_data.rows.each { |row| row.cells.delete_at(column_index) }
 
     # Change column numbers for cells to the right of the deleted column
@@ -271,7 +272,7 @@ module LegacyWorksheet
       add_row(sheet_data.size, :cells => Array.new(sheet_data.rows[row].size))
       (sheet_data.size - 1).downto(row+1) { |index|
         sheet_data.rows[index].cells[col] = sheet_data.rows[index-1].cells[col]
-      }
+      }                                                                             		
     else
       raise 'invalid shift option'
     end
@@ -282,30 +283,29 @@ module LegacyWorksheet
   # by default, only sets cell to nil
   # if :left is specified, method will shift row contents to the right of the deleted cell to the left
   # if :up is specified, method will shift column contents below the deleted cell upward
-  def delete_cell(row = 0, col=0, shift=nil)
+  def delete_cell(row_index = 0, column_index=0, shift=nil)
     validate_workbook
-    validate_nonnegative(row)
-    validate_nonnegative(col)
-
-    return nil unless row_exists(row) && column_exists(col)
+    validate_nonnegative(row_index)
+    validate_nonnegative(column_index)
 
-    cell = sheet_data[row][col]
+    row = sheet_data[row_index]
+    old_cell = row && row[column_index]
 
     case shift
     when nil then
-      sheet_data.rows[row].cells[col] = nil
+      row.cells[column_index] = nil if row
     when :left then
-      sheet_data.rows[row].delete_cell_shift_left(col)
+      row.delete_cell_shift_left(column_index) if row
     when :up then
-      (row...(sheet_data.size - 1)).each { |index|
-        c = sheet_data.rows[index].cells[col] = sheet_data.rows[index + 1].cells[col]
+      (row_index...(sheet_data.size - 1)).each { |index|
+        c = sheet_data.rows[index].cells[column_index] = sheet_data.rows[index + 1].cells[column_index]
         c.row -= 1 if c.is_a?(Cell)
       }
     else
       raise 'invalid shift option'
     end
 
-    return cell
+    return old_cell
   end
 
   private
@@ -326,8 +326,6 @@ module LegacyWorksheet
     validate_workbook
     validate_nonnegative(row)
 
-    return nil unless row_exists(row)
-
     xf_obj = get_row_xf(row)
     return nil if xf_obj.alignment.nil?
 
@@ -336,43 +334,13 @@ module LegacyWorksheet
     end
   end
 
-  def get_row_border(row, border_direction)
-    validate_workbook
-    validate_nonnegative(row)
-
-    return nil unless row_exists(row)
-
-    border = @workbook.borders[get_row_xf(row).border_id]
-    border && border.get_edge_style(border_direction)
-  end
-
   def column_font(col)
     validate_workbook
     validate_nonnegative(col)
-    return nil unless column_exists(col)
 
     @workbook.fonts[@workbook.cell_xfs[get_cols_style_index(col)].font_id]
   end
 
-  def get_column_alignment(col, type)
-    validate_workbook
-    validate_nonnegative(col)
-    return nil unless column_exists(col)
-
-    xf = @workbook.cell_xfs[get_cols_style_index(col)]
-    xf.alignment && xf.alignment.send(type)
-  end
-
-  def get_column_border(col, border_direction)
-    validate_workbook
-    validate_nonnegative(col)
-    return nil unless column_exists(col)
-
-    xf = @workbook.cell_xfs[get_cols_style_index(col)]
-    border = @workbook.borders[xf.border_id]
-    border && border.get_edge_style(border_direction)
-  end
-
   #validates Workbook, ensures that this worksheet is in @workbook
   def validate_workbook()
     unless @workbook.nil? || @workbook.worksheets.nil?
@@ -421,29 +389,8 @@ module LegacyWorksheet
     validate_nonnegative(row_index)
     validate_nonnegative(column_index)
 
-    existing_row_count = sheet_data.rows.size
-
-    # Expand cell arrays in existing rows, if necessary.
-    # Writing anything to a cell in the array automatically creates all the members
-    # with lower indices, filling them with +nil+s. But, we can't just write +nil+
-    # to +column_index+ because it may be less than +size+! So we read from that index
-    # (if it didn't exist, we will get nil) and write right back.
-    sheet_data.rows.each { |r| r.cells[column_index] = r.cells[column_index] unless r.nil? }
-
-    first_row = sheet_data.rows.first
-    col_size = [ first_row && first_row.cells.size || 0, column_index ].max
-
-    # Now create new rows with the required number of cells.
-    # Doing +.downto()+ here so the reallocation of row array has to only happen once,
-    # when it is extended to max size; after that, we will be writing into existing
-    # (but empty) members. Additional checks are not necessary, because if +row_index+
-    # is less than +size+, then +.downto()+ will not execute, and if it equals +size+,
-    # then the block will be invoked exactly once, which takes care of the case when
-    # +row_index+ is greater than the current max index by exactly 1.
-    row_index.downto(existing_row_count) { |r|
-      add_row(r, :cells => Array.new(col_size))
-    }
-  end
+    row = sheet_data.rows[row_index] || add_row(row_index)
+  end  
 
   # Helper method to get the style index for a column
   def get_col_style(column_index)
@@ -469,14 +416,5 @@ module LegacyWorksheet
   end
   private :validate_nonnegative
 
-  def column_exists(col)
-    sheet_data.rows.any? { |r| r && (r.cells.size > col) }
-  end
-
-  def row_exists(row)
-    sheet_data.rows.size > row
-  end
-
-
 end #end class
 end